docs: rewrite the explanation section
Metadata
Current evaluation
Merged documentation rewrite detailing Pebble, chisel, rocks, and overlay-step explanations. Resolved issues #337 and #348 and corrected broken documentation header styling.
Suggested action: —
No scores available.
Issue body
This PR add the explanation of Pebble and
rewrite chisel,rocks and overlay-step explanation.
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
Fixes #337
Fixes https://github.com/canonical/rockcraft/issues/348
https://canonical-rockcraft--327.com.readthedocs.build/en/327/
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation rewrite detailing Pebble, chisel, rocks, and overlay-step explanations. Resolved issues #337 and #348 and corrected broken documentation header styling. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation rewrite adding Pebble explanations and updating chisel, rocks, and overlay-step guides. Fixes issues #337 and #348. Includes a documentation header styling fix. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation rewrite covering Pebble, chisel, rocks, and overlay-step explanations. Resolved issues #337 and #348 and fixed broken documentation header styling following review updates. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1058 docs: referencing Pebble documentation | rockcraft | open | Updates the Pebble link in docs/explanation/pebble.rst from the GitHub repo to the official Pebble documentation page, plus minor spelling fixes. 2-line change, unreviewed, CI mostly green with one unrelated snap-tests failure. | |
| #847 docs: update pebble page and add references to pebble docs | rockcraft | open | Docs-only PR updating the Pebble explanation page to reference official Pebble docs and cross-linking Pebble mentions on other pages (7 files, +21/-20). Review requested changes 263 days ago; author never responded; same goal pursued in newer PR #1058. | |
| #737 doc: use the Pebble docs | rockcraft | open | Doc improvement to reshape the Pebble explanation page to rely on official Pebble docs. Intersphinx mapping updated to new Pebble docs URL, but the page's main Pebble link still points to GitHub and the page hasn't been reshaped. | |
| #304 Pebble doc and test updates | rockcraft | merged | Merged updates to Pebble documentation and spread tests. Fixed formatting issues and aligned content with recent Pebble features like --args. Approved by three reviewers and passed CI checks across ten files. | |
| #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. | |
| #765 docs: fix explanation pages | craft-parts | merged | Merged documentation update for Rockcraft and Craft Parts. Proofread explanation pages, fixed sections and links, and addressed undefined label warnings. Approved by three reviewers and integrated after confirming unrelated test failures. | |
| #779 Update link to Pebble layer specification | rockcraft | merged | Merged updates to the Pebble layer specification documentation, redirecting links to the new official docs site. Approved by two reviewers across six modified files. | |
| #310 docs: fix url of rockcraft format | rockcraft | merged | Merged a documentation fix correcting a broken URL in convert-to-pebble-layer.rst, resolving a linkcheck failure. Approved by two reviewers, passed CI, and modified one file. | |
| #404 docs: add an explanation of parts | craft-parts | merged | Merged documentation update explaining parts, adding 628 lines across nine files. Approved by one reviewer, references CRAFT-1612, and was finalized after initial feedback collection. |