docs: update package documentation (CRAFT-37)
Metadata
Current evaluation
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).
Suggested action: —
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 |
|---|---|---|---|---|
| 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 |
|---|---|---|---|---|
| #554 docs: update docs subproject readme | starbase | merged | Merged. Updated the docs subproject readme to correct outdated instructions and clarify that the documentation targets craft apps contributors. Approved by reviewers and passed all CI checks. | |
| #9 docs: update build procedure and fix warning | craft-store | merged | Merged updates consolidate API documentation configuration in conf.py for ReadTheDocs and fix a build warning. Approved by one reviewer, passed CI, and notes propagation to related craft-* projects. | |
| #800 many: reword docstrings and code comments | charmcraft | merged | Merged following single reviewer approval. Reworded docstrings and code comments across five files to improve clarity, resolving CRAFT-697. The +10/-10 line change passed all CI checks. | |
| #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. | |
| #318 docs: automate CLI reference documentation | rockcraft | merged | Merged automated CLI reference documentation generation. Approved by three reviewers, passed CI checks, and updated five files. Implements CRAFT-1779 to streamline documentation updates. | |
| #114 docs: update readme information | debcraft | merged | Merged after two approvals and passing CI checks. Updates the README with basic usage information consistent with other craft tools, resolving DEBCRAFT-25. Review feedback was incorporated prior to merge. | |
| #1199 docs: update README according to template | craft-parts | merged | Merged after two approvals and passing CI. Updates the README to align with a standard template, heavily inspired by Craft Application, modifying one file with 40 additions and 11 deletions. | |
| #49 Improved README and docs on how to use the lib (CRAFT-707). | craft-cli | merged | Successfully merged documentation updates improving the README and library usage guide. Approved by one reviewer, modified seven files with 582 additions and 10 deletions, resolving CRAFT-707. | |
| #14 docs: update title to Craft Archives | craft-archives | merged | Merged a documentation update changing the project title to Craft Archives. The single-line change across one file received reviewer approval and passed CI checks before integration. | |
| #72 docs: update documentation dependencies | craft-archives | merged | Documentation dependency updates were approved, passed CI checks, and successfully merged. The change modified a single file with minor adjustments. |