← Back to issue list

feat(docs): add craft-parts common documentation

View original Github issue

Metadata

Project
charmcraft
Number
#1939
Type
pull request
State
merged
Author
lengau
Labels
—
Created
Updated
Closed

Current evaluation

Merged as 534c028f, adding shared craft-parts documentation across eight files and laying groundwork for Python and Poetry plugin guides in #1940.

Resolution: closed resolved

Reason: The documentation PR was merged through commit 534c028f. Follow-up PR #1940 subsequently added the Python and Poetry plugin guides as 408650c8.

Evaluated by: mr-cal-bot

No scores available.

Issue body

This brings in the common documentation sets from craft-parts and adds some of the pages. It mostly exists to enable my next PR, where I'll document the `python` and `poetry` plugins.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged as 534c028f, adding shared craft-parts documentation across eight files and laying groundwork for Python and Poetry plugin guides in #1940.
stealth/space-bunny-alpha — closed resolved PR #1939 merged as 534c028f, importing the craft-parts common documentation set (8 files, +162/-2) to lay groundwork for documenting the python and poetry plugins.
stealth/space-bunny-alpha — closed resolved Merged charmcraft#1939, adding shared craft-parts documentation across eight files as the foundation for reusable Python and Poetry plugin guides.
stealth/space-bunny-alpha — closed resolved Merged charmcraft PR #1939 in 534c028f, integrating common craft-parts documentation across eight files as a foundation for Python and Poetry plugin guides.
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6 — — Merged import of common craft-parts documentation to support future python and poetry plugin guides.

Update history

No update history recorded yet.

Related work

  • Related To: charmcraft#1940 (confidence 99%)

    Direct follow-up adding the Python and Poetry plugin documentation enabled by #1939; merged as 408650c8.

  • Related To: charmcraft#1913 (confidence 97%)

    Documentation issue for Python and Poetry plugins fulfilled by #1940 after the common docs landed.

Related issues

Issue Project State Summary Similarity
#1940 feat(docs): add python and poetry plugin docs charmcraft merged PR #1940 merged as commit 408650c8, adding Python and Poetry plugin documentation (+144 lines, 6 files). Builds on #1939 (craft-parts common docs) and required craft-parts#872 anchors; merged despite12 unresolved review comments.
87%
#688 feat(docs)!: rework bundling of shared docs craft-parts merged Merged in 841244bd: reorganized reusable documentation under docs/common/craft-parts/ so Craft Parts and downstream applications can reference shared paths without conflicts.
79%
#4635 feat(docs): pull in content from craft-parts snapcraft merged Merged #4635, importing craft-parts documentation into Snapcraft across 21 files; landed as commit 055a93543 after three approvals.
76%
#809 Reference documenation for the poetry plugin craft-parts closed Added Poetry plugin reference documentation in merged PR canonical/craft-parts#830 (commit aec88860), resolving the missing documentation request.
76%
#830 feat(docs): add poetry plugin reference craft-parts merged Merged PR #830 as commit aec88860, adding Poetry plugin reference documentation across three files (+107/-1), following the plugin introduced in #820.
75%
#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%
#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).
74%
#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.
73%
#960 fix(docs): include poetry links as a target craft-parts merged Merged as commit af641b90 (+2 lines): added an RST `.. _craft_parts_poetry_links:` include target at the end of docs/common/craft-parts/reference/plugins/poetry_plugin.rst, so apps with a custom Poetry reference can include the default links.
73%
#486 docs: fixed broken references craft-parts merged Merged as canonical/craft-parts#486 via commit fd734825, correcting broken documentation references in four files; rebasing onto main cleared a Pydantic 2-related mypy failure.
73%