ROCK and chisselled ROCK tutorials have distracting diff
Metadata
Current evaluation
Planned alignment of the ROCK and Chisel tutorials was superseded when PR #1222 removed the duplicate Chisel tutorial, eliminating the distracting side-by-side diff.
Suggested action: close resolved
Reason: cjdcordeiro called this "a valid point" and included it in planned documentation improvements. Merged PR canonical/rockcraft#1222 (commit cd5c9ca3) later removed the duplicate "Shrink a rock with Chisel" tutorial in favor of the existing Chisel-a-rock how-to, so the reported tutorial-to-tutorial diff no longer exists.
Evaluated by: mr-cal-bot
Impact:
25
Quick Win:
20
Complexity:
15
Confidence:
96
Actionability:
92
Issue body
### Request type
Fix
### What needs to get done
Hi,
the niceness on ROCKs and chiselling is that, as chisel slices already exist, they are as easy to use as parts already are.
The problem is that I'd consider it likely that users will do both tutorials after each other and they will wonder why there is so much difference.
```
diff -Naur hello/rockcraft.yaml chiselled-hello/rockcraft.yaml
--- hello/rockcraft.yaml 2024-07-24 11:58:58.630846588 +0200
+++ chiselled-hello/rockcraft.yaml 2024-07-24 11:57:55.547364572 +0200
@@ -1,20 +1,16 @@
-# Metadata section
-
-name: hello
-summary: Hello World
-description: The most basic example of a rock.
-version: "latest"
+name: chiselled-hello
+summary: Hello world from Chisel slices
+description: A "bare" rock containing the "hello" package binaries from Chisel slices.
license: Apache-2.0
+version: "latest"
base: bare
-build-base: ubuntu@22.04
+build_base: "ubuntu@22.04"
platforms:
- amd64: # Make sure this value matches your computer's architecture
-
-# Parts section
+ amd64:
parts:
hello:
plugin: nil
stage-packages:
- - hello
+ - hello_bins
```
If I'm not mistaken only the last hunk is the real change.
Aligning those to really be just different there would help to see how easy it is to use (existing) slices.
### Documentation location
_No response_
### Additional information
_No response_
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
25
Quick Win:
20
Complexity:
15
Confidence:
96
Actionability:
92
|
close resolved | Planned alignment of the ROCK and Chisel tutorials was superseded when PR #1222 removed the duplicate Chisel tutorial, eliminating the distracting side-by-side diff. | |
| qwen/qwen3.6-35b-a3b |
Impact:
20
Quick Win:
12
Complexity:
15
Confidence:
65
Actionability:
70
|
keep open | Documentation inconsistency between ROCK and chiselled ROCK tutorials; YAML files differ more than necessary, obscuring the actual changes. Acknowledged by maintainer as valid. | |
| qwen/qwen3.8-27b |
Impact:
15
Quick Win:
14
Staleness:
80
Complexity:
10
Confidence:
85
Support Request:
0
|
close stale | Docs nit: hello and chiselled-hello tutorial rockcraft.yaml files had distracting diffs beyond the real change. The chiselled-hello tutorial was removed in #1222 and chisel content moved to how-to guides, making the issue moot. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
60
Complexity:
10
Confidence:
85
Support Request:
10
|
keep open | Documentation tutorial alignment requested to reduce distracting diffs between ROCK and chiselled ROCK examples. Acknowledged by maintainer as valid and slated for a planned improvement batch, but inactive for ~7 months. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
68
Complexity:
10
Confidence:
75
Support Request:
0
|
keep open | Documentation issue where ROCK and chiselled ROCK tutorials show a large, distracting diff. Acknowledged by maintainers as valid, but inactive for ~7 months. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
75
Complexity:
10
Confidence:
80
Support Request:
10
|
keep open | Documentation issue where ROCK and chiselled ROCK tutorials show a large, distracting diff. Maintainer acknowledged it as valid in July 2024, but no fixes or updates have occurred since. |
Update history
No update history recorded yet.
Related work
-
Superseded By:
canonical/rockcraft#1222
(confidence 98%)
PR #1222 removed the duplicate Chisel tutorial that caused the reported distracting comparison.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1222 docs: Remove "Shrink a rock with Chisel" tutorial | rockcraft | merged | Merged PR #1222 (commit cd5c9ca3), removing the duplicate “Shrink a rock with Chisel” tutorial in favor of the existing Chisel-a-rock how-to guide. |