← Back to issue list

refactor(docs) move more docs to the shared base

View original Github issue

Metadata

Project
craft-parts
Number
#680
Type
pull request
State
merged
Author
tigarmo
Labels
—
Created
Updated
Closed

Current evaluation

Merged #680 as 3af25880, moving referenced docs into the shared base and adding Python plugin-reference bookend labels so Snapcraft can reuse them.

Resolution: closed resolved

Reason: The documentation refactor was merged in commit 3af25880 after approval. It enables Snapcraft to reuse shared-base docs while exposing the Python plugin reference through bookend labels.

Evaluated by: mr-cal-bot

No scores available.

Issue body

The real intent of this PR is the second commit (the "bookend" labels in the Python plugin reference), but in order to use that in Snapcraft we need to add other documents to the shared base, because they are referenced by the plugin docs.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged #680 as 3af25880, moving referenced docs into the shared base and adding Python plugin-reference bookend labels so Snapcraft can reuse them.
stealth/space-bunny-alpha — closed resolved Merged in canonical/craft-parts#505: moved referenced documentation into the shared base and added bookend labels to the Python plugin reference, enabling reuse from Snapcraft.
qwen/qwen3.6-35b-a3b — — Merged after approval by two reviewers. Documentation was refactored by moving additional files to a shared base to support bookend labels in the Python plugin reference. Changed 12 files with 575 additions and 561 deletions.
qwen3.6-35b-a3b-mtp-q6 — — Merged a documentation refactor moving additional files to a shared base. This resolves cross-document dependencies to enable Python plugin reference updates, specifically adding bookend labels.

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 #4679 as b8c9a17dc, replacing duplicated Snapcraft docs with direct craft-parts TOC references or includes for shared content.
76%
#505 docs: make Python plugin reference reusable craft-parts merged Merged PR #505 in commit 9c1576e5, moving the Python plugin reference into shared docs so other craft_parts_docs documentation sets can reuse it.
74%
#5409 docs: migrate 'migrate between bases' snapcraft merged Merged in snapcraft#5409 via commit 30aeaf036, migrating and restructuring the documentation for changing snap bases.
71%
#411 docs: refer to the working directory craft-parts merged Merged docs cleanup in #411 (commit cf66c5c3), replacing overly Snapcraft-specific wording with references to the working directory.
70%