docs: minor clean up and reorg
Metadata
Current evaluation
Merged in #529 via commit 50567fc, reorganizing how-to docs, correcting boilerplate indentation and conf.py lint issues, and adding landing-page descriptions.
Resolution: closed resolved
Reason: PR #529 was approved and merged. Commit 50567fc contains the completed documentation cleanup across eight files.
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in #529 via commit 50567fc, reorganizing how-to docs, correcting boilerplate indentation and conf.py lint issues, and adding landing-page descriptions. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #529 reorganized the docs, moved how-to-guides to how-to, corrected boilerplate indentation, added landing-page descriptions, and fixed Ruff linting in conf.py. | |
| 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 |
|---|---|---|---|---|
| #2217 docs: rewrite home page | charmcraft | merged | Merged PR #2217 in commit 9f3d6ebd, rewriting the documentation home page to the standard model and fixing reference-doc lint errors; remaining feedback was deferred. | |
| #5441 docs: revise home page | snapcraft | merged | Merged in #5441 via commit 881b9e464, revising the documentation homepage after rebasing onto the reorganized table of contents. | |
| #223 docs: refine landing pages | imagecraft | merged | Merged in commit c58ecb8, adding Diátaxis landing pages, basic-group indexes, reorganized common-parts explanations, and standardized filenames and labels. |