feat(docs)!: rework bundling of shared docs
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
This PR re-organizes the docs/ folder to share *most* of the rst files. Moving forward, the expectation is that new content will be written inside of docs/common/craft-parts/ if there is any expectation at all that downstream applications will want to include it in their own docs. The idea is to keep to the /common/craft-parts/ folder so that both Craft Parts and applications can refer to the docs using the same path, without overlaps/conflicts.
Not everything is shared - some docs are kept in Craft Parts as they are not meant to be consumed by users of downstream applications. Some examples:
- Class references to Craft-parts internals;
- Docs about using ``craft-parts`` directly from the command line;
- "Meta documentation" about documenting the library itself;
- Front-page and tables of contents that structure Craft Parts' own docs.
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
This PR is split over multiple commits to simplify review. The first commit has most of the changes but they are all shuffling files around.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged docs reorganization sharing most RST files via a common path for downstream applications. Craft Parts internals and CLI guides remain local. Split into multiple commits for review. |
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. | |
| #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. | |
| #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. | |
| #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. | |
| #103 docs: update package documentation (CRAFT-37) | craft-parts | merged | Merged documentation updates reorganizing the layout, improving docstrings, and adding lifecycle and class diagrams. Approved by two reviewers, passed CI, and changed 21 files (+511/-83). | |
| #1939 feat(docs): add craft-parts common documentation | charmcraft | merged | Merged documentation update integrating common craft-parts reference material across eight files. Approved by two reviewers, the change establishes the foundation for upcoming python and poetry plugin guides. | |
| #960 fix(docs): include poetry links as a target | craft-parts | merged | Merged a documentation fix adding an RST include directive that enables custom poetry plugins to reference default craft-parts links. Approved by two reviewers, passed CI, and applied with a two-line change. | |
| #2186 docs: fix build errors | charmcraft | merged | Merged a one-line documentation fix to resolve recent build errors. Approved by two reviewers. Remaining build issues were subsequently addressed in craft-parts pull request 1021. | |
| #599 feat: create reusable setup instructions | rockcraft | merged | Merged changes that replace tutorial prerequisites sections with a reusable RST file. Approved by three reviewers, the update modifies eight files to standardize setup instructions across documentation. | |
| #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. |