docs: updating homepage to new requirements
Metadata
Current evaluation
Merged PR #1066 (commit 0af1a05b) rewrote docs/index.rst to the 26.04 homepage model: new intro, "In this documentation", "How this documentation is organized" and Project/Community sections. Approved after 37 review comments; later refined by #1292.
Resolution: closed resolved
Reason: The PR was merged into main as squash commit 0af1a05b ("docs: updating homepage to new requirements (#1066)"), confirmed in the history of docs/index.rst, with review status approved and all CI checks passing. The resulting sections remain in the current homepage, later incrementally updated by follow-up PRs #1292 and #1369.
Evaluated by: mr-cal-bot
No scores available.
Issue body
A new model is implemented for the Rockcraft docs homepage based on the template for 26.04. This includes:
- An updated introduction section to mention what the product is, what the product does, what need the product meets and whom the product is useful for.
- A new "In this documentation" section that systematically exposes the documentation’s contents.
- An updated "How this documentation is organized" section that sets expectations for the reader.
- An updated "Project and Community" section with some information added.
---
- [x] I've followed the [contribution guidelines](https://github.com/canonical/rockcraft/blob/main/CONTRIBUTING.md).
- [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [ ] I've successfully run `make lint && make test`.
- [x] I've added or updated any relevant documentation.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #1066 (commit 0af1a05b) rewrote docs/index.rst to the 26.04 homepage model: new intro, "In this documentation", "How this documentation is organized" and Project/Community sections. Approved after 37 review comments; later refined by #1292. | |
| stealth/space-bunny-alpha | — | closed resolved | Docs PR #1066 by asanvaq was merged (commit 0af1a05b), rewriting docs/index.rst homepage per the 26.04 template: new intro, "In this documentation", "How this documentation is organized" and "Project and Community" sections. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #1066 (0af1a05b), updating the Rockcraft homepage to the 26.04 requirements with revised introduction, documentation contents, organization, and project/community sections. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged after reviewer approval and passing all CI checks. Updated the Rockcraft documentation homepage to match 26.04 template requirements, adding structured sections and improved navigation. Minor link checker warnings were noted and accepted. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update aligning the Rockcraft homepage with 26.04 template requirements. Reviewer feedback was addressed, whitespace issues were fixed, and a link checker warning was resolved by adding the problematic URL to linkcheck_ignore. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/rockcraft#1292
(confidence 92%)
Merged follow-up adjusting the same "In this documentation" section for new domains of concern.
-
Related To:
canonical/rockcraft#1369
(confidence 70%)
Later PR converting the same homepage section to the structured-toc extension; closed unmerged, does not undo #1066.
-
Related To:
canonical/rockcraft#1246
(confidence 45%)
Merged PR adding metadata to remaining pages, part of the same docs standards work.
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. | |
| #2648 docs: adopt new home page model | charmcraft | merged | Merged docs PR (commit d582c146): adopted the new documentation home page model with redesigned 'In this documentation' section, renamed the tutorials index to 'Tutorials', and updated how-to section titles. | |
| #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. | |
| #6000 docs: adopt the new homepage model | snapcraft | merged | Merged PR #6000 in commit 2f3c79332, adopting the standard documentation homepage and adding an “In this documentation” section organized by key Snapcraft domains. | |
| #96 update homepage | snapcraft | merged | Merged PR #96 updated homepage content in two files (3 additions, 3 deletions) via commit 59d4e0583, merged as f5761813f. | |
| #65 Improve the docs homepage | imagecraft | merged | Docs-only PR by rkratky merged into main as commit 84523ef (merge 0d59203): fixed the homepage navigation grid, added homepage info, and corrected spelling. Later refined by #111, #317 and #339. | |
| #317 docs: add home page content | imagecraft | merged | Merged documentation PR #317 added standard-model-compliant home page content in commit 178f32e. | |
| #1292 docs: apply new domains of concern to homepage | rockcraft | merged | Merged PR #1292 updated the documentation homepage’s “In this documentation” section with the newly agreed domains of concern. | |
| #31 docs: update main page with the standard template | craft-archives | merged | Merged PR #31 updated the main documentation page to the standard template; the change landed in commit bde6712. | |
| #1369 docs: update homepage using new structured-toc extension | rockcraft | closed | Merged the homepage update to use structured-TOC domain/slice directives; commit ff41e52d records PR #1369 in the main history. |