docs: minor clean up and reorg
Metadata
Current evaluation
Merged after two approvals. Docs were reorganized by moving docs/how-to-guides to docs/how-to, fixing indentation, adding default descriptions, and resolving ruff linting in conf.py. Changes touch 8 files.
Suggested action: —
No scores available.
Issue body
Apply better patterns:
- Move `docs/how-to-guides` to `docs/how-to`.
- Fix indentation in some boilerplate.
- Add default descriptions to landing pages.
- Fix some ruff linting problems in `conf.py`.
---
- [x] I've followed the [contribution guidelines](https://github.com/canonical/starbase/blob/main/CONTRIBUTING.md).
- [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [x] I've successfully run `make lint && make test`.
- [x] I've added or updated any relevant documentation.
- [ ] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing.
- [ ] I've updated the relevant release notes.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged after two approvals. Docs were reorganized by moving docs/how-to-guides to docs/how-to, fixing indentation, adding default descriptions, and resolving ruff linting in conf.py. Changes touch 8 files. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation cleanup and reorganization. Relocated docs/how-to-guides to docs/how-to, fixed indentation, added default landing page descriptions, and resolved ruff linting in conf.py. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #877 docs: Reorganize 12-factor how-to guides | rockcraft | merged | Merged documentation reorganization splitting the 12-factor how-to guide into initialization, configuration, and usage files under a new directory. Updated index and added redirect. Approved by two reviewers and merged after passing doc lint. | |
| #5586 docs: improve and move setup guides | snapcraft | merged | Merged documentation update improving and relocating setup guides per internal feedback. Approved by two reviewers and passed CI checks. Changes span five files, streamlining contributor onboarding. | |
| #1582 docs: correct the 'organize' description | craft-parts | merged | Merged a documentation update correcting the 'organize' description. Approved by two reviewers with a three-line change across one file. Successfully integrated after passing required checks. | |
| #4358 style(docs): fix linter errors for auto-generated commands | snapcraft | merged | Merged via rebase-and-merge after two approvals and passing CI. Fixed linter errors in auto-generated documentation by ensuring docs are built prior to linting. Modified 5 files with negligible coverage impact. | |
| #5530 docs: misc fixes | snapcraft | merged | Merged documentation updates removing a Ruby how-to guide and fixing typos based on feedback from PR #5528. Approved by two reviewers and integrated into the codebase. | |
| #122 docs: update wording in howtos.rst | craft-cli | merged | Documentation wording in howtos.rst was updated and merged after reviewer approval. Changes involved minor text edits (+7/-7 lines) with no unresolved comments or CI checks. | |
| #10 docs: improve README | snapcraft-rocks | merged | Merged documentation update improving the README. Approved by two reviewers, adding 66 lines and removing one across a single file. | |
| #1302 docs: rewrite some redirects | craft-parts | merged | Merged documentation rewrite correcting several redirects to resolve recurring lint CI failures. Approved by two reviewers, passed all CI checks, and modified four files with minimal changes. | |
| #180 docs: add 'About this documentation' | imagecraft | merged | Merged after two reviewers approved. Added an About this documentation section to the project docs. Passed lint, security, and build checks despite failing spread tests on Ubuntu variants. Changes added 70 lines across two files. | |
| #354 docs: move changlog to docs toplevel directory | craft-parts | merged | Merged a documentation update relocating the changelog to the docs toplevel directory for better discoverability. Approved by one reviewer, passed CI checks, and modified two files. |