← Back to issue list

refactor(docs): use more docs from craft-parts

View original Github issue

Metadata

Project
snapcraft
Number
#4679
Type
pull request
State
merged
Author
tigarmo
Labels
—
Created
Updated
Closed

Current evaluation

Merged #4679 as b8c9a17dc, replacing duplicated Snapcraft docs with direct craft-parts TOC references or includes for shared content.

Resolution: closed resolved

Reason: PR #4679 was approved and merged into main as commit b8c9a17dc, completing the documentation refactor.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Now that the structure of the shared craft-parts docs has more content, we can simplify our own docs and just use craft-parts' directly in many places. The guideline is this: If the document will be used wholesale, just reference it directly in the TOC. Otherwise, `include` it in a Snapcraft docs.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged #4679 as b8c9a17dc, replacing duplicated Snapcraft docs with direct craft-parts TOC references or includes for shared content.
stealth/space-bunny-alpha — closed resolved Merged PR #4679 as b8c9a17dc, replacing duplicated Snapcraft documentation with direct TOC references or includes for shared craft-parts docs.
qwen/qwen3.6-35b-a3b — — Merged documentation refactor replacing duplicated content with direct references or includes from shared craft-parts docs. Approved by two reviewers, passed CI, modified 18 files, and maintained 100% test coverage on changed lines.
qwen3.6-35b-a3b-mtp-q6 — — Merged a documentation refactor replacing duplicated content with direct references and includes to the shared craft-parts docs. Changes passed automated tests and were merged by the maintainer.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#515 refactor(docs): use more docs from craft-parts rockcraft merged Merged #515 refactored Rockcraft docs to reuse Craft Parts pages via direct TOC links or local includes (commit 5c2263f1).
84%
#4635 feat(docs): pull in content from craft-parts snapcraft merged Merged #4635, importing craft-parts documentation into Snapcraft across 21 files; landed as commit 055a93543 after three approvals.
79%
#247 docs: include some docs from craft-parts rockcraft closed PR pulling craft-parts docs into rockcraft was left unmerged and closed as redundant; the same docs refactor landed instead via rockcraft#515 (commit 5c2263f1, "refactor(docs): use more docs from craft-parts").
77%
#1031 docs: add new how-to for parts craft-parts merged Merged PR #1031 via commit 31a15e7e, adding a generalized Craft Parts how-to adapted from Snapcraft documentation and a changelog entry.
77%
#688 feat(docs)!: rework bundling of shared docs craft-parts merged Merged in 841244bd: reorganized reusable documentation under docs/common/craft-parts/ so Craft Parts and downstream applications can reference shared paths without conflicts.
77%
#680 refactor(docs) move more docs to the shared base craft-parts merged Merged #680 as 3af25880, moving referenced docs into the shared base and adding Python plugin-reference bookend labels so Snapcraft can reuse them.
76%
#4682 refactor(app): use more code from craft-app snapcraft merged Merged as c9b6941d4, replacing Snapcraft-specific application logic with craft-app functionality (36 additions and 49 deletions across three files).
76%
#314 docs: clean up references to Craft Parts rockcraft closed Craft Parts documentation cleanup was folded into canonical/rockcraft#308, merged as commit 13bf8368, and #314 was closed.
76%
#4948 docs: exclude overlay step, bump craft-parts to 1.34.0 snapcraft merged Merged in canonical/snapcraft#4948, fixing the docs build by excluding overlay-step docs and bumping craft-parts to 1.34.0 (f57f7e0c0, de13316cb).
74%
#472 Update docs to use craft-parts features correctly craft-application closed Merged PR #475 (commit d448c449) updated the partitions guide to remove production Features.reset() guidance and document the craft-parts feature override.
74%