← Back to issue list

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

View original Github issue

Metadata

Project
rockcraft
Number
#515
Type
pull request
State
merged
Author
tigarmo
Labels
Created
Updated
Closed

Current evaluation

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.

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 Rockcraft doc.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b 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.
qwen3.6-35b-a3b-mtp-q6 Merged a documentation refactor replacing duplicated content with direct references or includes from the shared craft-parts repository. Docs are linked wholesale in the table of contents and included inline where partial usage is needed.
qwen3.6-35b-a3b-mtp-q6 Merged a documentation refactor that eliminates duplication by directly referencing or including craft-parts docs. Established a guideline to link wholesale content in the TOC and embed others directly in Rockcraft docs.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#4679 refactor(docs): use more docs from craft-parts snapcraft merged 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.
94%
#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.
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.
78%
#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.
78%
#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%
#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.
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.
76%
#5205 refactor: use craft-platforms utilities snapcraft merged Merged following approval by two reviewers. Refactored the codebase to use craft-platforms utilities, resolving CRAFT-3278 and closing #4993. Net reduction of 307 lines across 20 files.
76%
#1897 refactor: move parts plugins to their own module charmcraft merged Merged a refactor by maintainer lengau that relocates parts plugins to a dedicated module, decoupling them from craft-parts. Approved by two reviewers, modifying 11 files (+72/-37).
76%