← Back to issue list

docs: reorganise pages

View original Github issue

Metadata

Project
snapcraft
Number
#5440
Type
pull request
State
merged
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

Docs-only PR by medubelko reorganising documentation page hierarchy and chunking content (140 files, +504/-526). Approved by 2 reviewers and merged as commit 47574a240 after spread tests were unjammed.

Resolution: closed resolved

Reason: PR #5440 was merged into main as commit 47574a240 ('docs: reorganise pages (#5440)'), confirmed in git history. The maintainer closed it with the comment 'Unjammed the spread tests. Merging.' after 2 approvals.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Reorganise the hierarchy of pages to better reflect the correct learning path, and chunk content appropriately. When reviewing, I suggest looking at the preview build rather than the code. --- - [x] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `make lint`? ---

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Docs-only PR by medubelko reorganising documentation page hierarchy and chunking content (140 files, +504/-526). Approved by 2 reviewers and merged as commit 47574a240 after spread tests were unjammed.
stealth/space-bunny-alpha — closed resolved Merged as commit 47574a240 (#5440), reorganizing documentation pages to clarify the learning path and better chunk content.
qwen/qwen3.6-35b-a3b — — Merged after reorganizing documentation pages to improve the learning path and content chunking. Approved by two reviewers, failing integration tests were resolved, and the maintainer completed the merge.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation reorganization restructuring page hierarchy to align with the intended learning path and chunk content appropriately. The maintainer unjammed spread tests and approved the merge following preview build review.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/snapcraft#529 (confidence 45%)

    Follow-on/fellow docs reorg commit 50567fce8 ('docs: minor clean up and reorg') touching the same docs hierarchy later.

Related issues

Issue Project State Summary Similarity
#142 refactor(docs): separate documentation pages craft-store merged Merged PR #142 as commit da8329c, separating documentation into dedicated pages across eight files (+426/-418).
78%
#447 docs: rename page, change order, fix markup craft-parts merged Merged in PR #447 (commit ca99dcda): renamed a documentation page, reordered content, and corrected markup.
77%
#365 docs: convert repo docs to markdown starbase merged Merged in commit 3fe6515 (PR #365), converting five repository documentation files to Markdown (+462/-513), with two approvals.
74%
#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.
73%
#126 Docs improvements rockcraft merged Merged into main as commit 68a7abda, updating 11 documentation files (+73/-27) after approval and a maintainer rebase.
72%
#1142 docs: maintain contributing.md craft-parts merged Merged docs PR by maintainer medubelko fixing an error and improving a step in CONTRIBUTING.md (+3/-4 lines). Approved by 2 reviewers, all CI green; landed as commit 14b47207 ('docs: maintain contributing.md (#1142)').
72%
#250 docs: fix markup rockcraft merged Merged in 4c458b4f, fixing four approved documentation markup issues across six files; remaining lint fixes were deferred to a follow-up PR.
72%
#143 docs: make docs spread-testable craft-store merged Merged PR #143 as commit 1676433, adding infrastructure to manually spread-test the restructured documentation without running docs spread tests in CI.
72%
#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.
71%
#554 docs: update docs subproject readme starbase merged PR #554 by medubelko merged as commit 0b67b94, rewriting docs/README.md with corrected, more detailed steps for updating the docs (Sphinx Stack) subproject; approved by 2 reviewers, all CI green.
70%