ROCK and chisselled ROCK tutorials have distracting diff
Metadata
Current evaluation
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.
Suggested action: close stale
Reason: The chiselled-hello tutorial referenced in this issue was removed in PR #1222 (commit cd5c9ca3 'docs: Remove Shrink a rock with Chisel tutorial'), and chisel documentation was restructured into how-to guides (e.g. docs/how-to/chiseling/chisel-existing-rock.rst). The current tutorial index no longer lists a chisel tutorial, so the side-by-side diff problem no longer exists. The issue is no longer applicable to the current documentation structure.
Impact:
15
Quick Win:
13.5
Staleness:
80
Complexity:
10
Confidence:
85
Support Request:
0
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 |
|---|---|---|---|---|
| qwen/qwen3.8-27b |
Impact:
15
Quick Win:
13.5
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. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
55
Complexity:
10
Confidence:
90
Support Request:
0
|
keep open | Align ROCK and chiselled ROCK tutorial YAML files to minimize distracting diffs and highlight actual changes. Acknowledged by maintainers and queued for planned documentation updates. Awaiting assignment. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
rockcraft#1222
(confidence 80%)
PR #1222 removed the 'Shrink a rock with Chisel' tutorial, eliminating the chiselled-hello tutorial that had the distracting diff. Chisel content was restructured into how-to guides instead.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1222 docs: Remove "Shrink a rock with Chisel" tutorial | rockcraft | merged | Merged documentation changes removing the duplicate Shrink a rock with Chisel tutorial in favor of the Chisel a rock how-to guide. This reduces redundancy, improves SEO, and aligns with Diàtaxis standards. Approved by reviewer and passed all CI checks. | |
| #1267 docs: Remove Chisel-related duplicated content | rockcraft | merged | Merged documentation update removing outdated Chisel content and duplicated guides. Updated the Chisel-Rockcraft relationship explanation and fixed a custom slice installation placeholder. Addressed feedback by removing a flaky Spread test. Approved and merged despite minor CI warnings. | |
| #98 Chisel documentation | rockcraft | merged | Merged after approval and passing CI. Updated the ReadTheDocs template, corrected styling, and added a Chisel explanation with parts reference to the Rockcraft documentation. | |
| #587 docs: add rockcraft chisel notes | craft-parts | merged | Merged documentation update adding rockcraft chisel notes. Approved by two reviewers, the maintainer added nine lines to one file. Changes were integrated into the repository without CI checks or additional comments. |