← 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 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.

Suggested action:

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
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.
qwen3.6-35b-a3b-mtp-q6 Merged a documentation refactor replacing duplicated content with direct references or includes from craft-parts. Docs now reference wholesale content in the TOC or include it inline. Codecov confirmed full coverage.

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 a documentation refactor simplifying the repository by directly referencing or embedding shared craft-parts docs. Approved by two reviewers, the update modifies 19 files, adding 61 and removing 38 lines.
94%
#4635 feat(docs): pull in content from craft-parts snapcraft merged Merged documentation update pulling content from craft-parts. Approved by three reviewers, passed CI, and achieved full test coverage on modified lines. The change modified 21 files with 123 additions and 5 deletions.
81%
#501 feat(docs): pull in content from craft-parts rockcraft merged Merged documentation updates pulling content from craft-parts. Approved by two reviewers, the change modified 18 files with 103 additions and 17 deletions.
81%
#4682 refactor(app): use more code from craft-app snapcraft merged Merged a refactoring update consolidating app code by leveraging more craft-app functionality. Approved by two reviewers, passed CI and coverage checks, and modified three files with a net reduction of 13 lines.
80%
#1334 refactor(parts): move craft-parts related things into their own package charmcraft merged Merged a refactor that moves craft-parts components into a dedicated package. Approved by two reviewers with zero unresolved comments. The change modifies 16 files, adding 960 lines and removing 794.
79%
#1195 docs: remove Craft Parts links from docstrings craft-parts merged Merged after reviewer approval and passing CI. Removed Craft Parts links from docstrings, replacing them with internal references for proper versioning and resilience. A changelog entry was added per reviewer request.
79%
#142 refactor(docs): separate documentation pages craft-store merged Merged after two reviewer approvals and passing CI. The change refactored documentation by separating pages across eight files, adding 426 and removing 418 lines. All guidelines and checks were satisfied.
79%
#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.
78%
#294 docs: import Craft Parts documentation fragments rockcraft merged Merged after two reviewers approved and requested rebasing to sync with main. The change imports Craft Parts documentation fragments. CI passed, and preview confirms successful integration pending a Craft Parts release.
77%
#688 feat(docs)!: rework bundling of shared docs craft-parts merged Merged a documentation reorganization that consolidates shared RST files into a common craft-parts directory while keeping internal and application-specific content separate. Approved by two reviewers and passed CI.
77%