docs: update package documentation (CRAFT-37)
Metadata
Current evaluation
Merged #103 in commit ae6ca192, reorganizing package docs, adding an introductory usage tutorial and lifecycle/class diagrams, and improving docstrings.
Resolution: closed resolved
Reason: PR #103 was approved and merged as commit ae6ca192, completing the documented CRAFT-37 documentation reorganization and additions.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Reorganize documentation layout to place a simple usage tutorial at
the start. Also improve docstrings and add lifecycle and class
layout diagrams.
Further documentation updates and fixes expected as package development
continues. Application plugin tutorial/example to be added after adding
environment verification to the plugin API.
Signed-off-by: Claudio Matsuoka <claudio.matsuoka@canonical.com>
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged #103 in commit ae6ca192, reorganizing package docs, adding an introductory usage tutorial and lifecycle/class diagrams, and improving docstrings. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #103 in commit ae6ca192, reorganizing package documentation, adding an introductory usage tutorial and lifecycle/class diagrams, and improving docstrings. | |
| qwen/qwen3.6-35b-a3b | — | — | 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). | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates reorganizing the layout with a usage tutorial, improving docstrings, and adding lifecycle and class layout diagrams. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #398 docs: update package description in index.rst | craft-parts | merged | Merged into main as commit 80dc1cc5, updating docs/index.rst to move the landing page closer to the standard documentation template and clarify Craft Parts’ package purpose. | |
| #1104 docs: update links | craft-parts | merged | Merged broken-link documentation fixes in craft-parts#1104 via commit 95a2b69a, updating two documentation files (+3/-1). | |
| #49 Improved README and docs on how to use the lib (CRAFT-707). | craft-cli | merged | Merged in canonical/craft-cli#49 via d5f6567, improving the README and library usage documentation for CRAFT-707 across seven files. | |
| #46 docs: basic reference documentation | craft-platforms | merged | Merged foundational Craft Platforms reference documentation in #46 via commit 337c743, adding 187 lines across 16 files. | |
| #81 docs: add additional info to readme | craft-providers | merged | Merged in craft-providers#81 via commit 554e87d (merge 1290a23), expanding the README with test, dependency-freezing, documentation, and commit-message guidance. | |
| #114 docs: update readme information | debcraft | merged | Merged canonical/debcraft#114 (commit 9aa2f55, DEBCRAFT-25): README gained a 'Basic usage' section documenting debcraft init and debcraft pack, styled like other Craft tools; +27/-7 lines, one file. | |
| #258 docs: update readme and template, fix build error | starbase | merged | Merged PR #258 in commit 7d2790e, improving README and docs-preparation guidance and disabling PDF/EPUB generation to restore the documentation build. | |
| #1539 docs: prepare 2.31.0 release | craft-parts | merged | Merged PR #1539 as commit 659aafa6, updating documentation to prepare the craft-parts 2.31.0 release. | |
| #1002 docs: Reference document for the PackageService | craft-application | merged | Merged docs-only PR #1002 (commit fc91d414, CRAFT-4503) adding docs/reference/services/package.rst with an autoclass API reference for PackageService, wired into the services index. All CI checks passed. | |
| #1705 docs: update changelog | craft-parts | merged | Merged into main, updating the Craft Parts changelog (+10/-3 across two files) via commit 8a4c645a. |