← 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 #515 refactored Rockcraft docs to reuse Craft Parts pages via direct TOC links or local includes (commit 5c2263f1).

Resolution: closed resolved

Reason: PR #515 was approved and merged without failing checks, resolving duplicated documentation by reusing shared Craft Parts content in commit 5c2263f1.

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

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged #515 refactored Rockcraft docs to reuse Craft Parts pages via direct TOC links or local includes (commit 5c2263f1).
stealth/space-bunny-alpha — closed resolved Merged PR #4679 refactored Snapcraft documentation to reuse shared craft-parts docs, replacing duplicated content with direct TOC links or Rockcraft includes.
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.

Update history

No update history recorded yet.

Related work

  • Related To: rockcraft#247 (confidence 90%)

    Earlier work to include Craft Parts docs was made redundant by the broader refactor merged in #515.

Related issues

Issue Project State Summary Similarity
#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").
88%
#4679 refactor(docs): use more docs from craft-parts snapcraft merged Merged #4679 as b8c9a17dc, replacing duplicated Snapcraft docs with direct craft-parts TOC references or includes for shared content.
84%
#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.
80%
#501 feat(docs): pull in content from craft-parts rockcraft merged Merged via commit 3f934304, importing Craft Parts content into 18 Rockcraft documentation files (+103/-17).
77%
#308 docs: imported the part properties reference from Craft Parts rockcraft merged Imported Craft Parts' part-properties reference into Rockcraft docs; PR #308 merged as 13bf8368 after upstream craft-parts#483 and #486 enabled and corrected the reusable documentation.
77%
#405 Remove the "Rockcraft Parts" page rockcraft closed Merged PR #419 removed the redundant “Rockcraft Parts” page and Chisel content after Craft Parts documentation became the canonical reference.
75%
#297 docs: rockcraft.yaml reference rockcraft closed Redirected to craft-parts documentation for `organize`; no Rockcraft PR or commit fixed the missing in-tree reference, and documentation integration was only planned.
74%
#322 docs: enable inclusion of overlay document rockcraft merged Merged PR #322 in commit 181c9e1c, enabling inclusion of the Craft Parts overlay document in Rockcraft's documentation.
74%
#634 feat: use versioned form of doc urls rockcraft merged Merged PR #634 updated Rockcraft error messages and init templates to use versioned documentation URLs, including the running version in links.
73%
#289 docs: expand rockcraft.yaml reference rockcraft merged Merged into main via commit 654c9c01, reorganizing reference docs and expanding the rockcraft.yaml configuration reference across seven files.
73%