← Back to issue list

docs: use folders for each axis

View original Github issue

Metadata

Project
craft-cli
Number
#456
Type
pull request
State
merged
Author
bepri
Labels
Created
Updated
Closed

Current evaluation

Merged documentation restructuring that organizes Reference, Tutorials, and Explanation into folders. Added link redirects and fixed a docs build issue for the Starbase update. Approved by two reviewers with all CI checks passing.

Suggested action:

No scores available.

Issue body

- [ ] Have you followed the guidelines for contributing? - [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you successfully run `make lint && make test`? --- This is done in preparation for a Starbase update. I didn't make any attempt to improve content or fix anti-patterns within any of the files, I only aimed to get Craft CLI aligned with the structure of other projects. - Made Reference, Tutorials, and Explanation into folders with top-level `index.rst` files and each topic moved into its own file - Added redirects for broken links this may have created - Fixed a docs build issue that sometimes came up

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged documentation restructuring that organizes Reference, Tutorials, and Explanation into folders. Added link redirects and fixed a docs build issue for the Starbase update. Approved by two reviewers with all CI checks passing.
qwen3.6-35b-a3b-mtp-q6
Staleness: 10
Complexity: 15
Confidence: 85
needs review Restructures documentation into folders for Reference, Tutorials, and Explanation with index files and redirects. Fixes a docs build issue. Currently awaiting maintainer review with no comments or labels.
qwen3.6-35b-a3b-mtp-q6
Staleness: 5
Complexity: 15
Confidence: 85
needs review Restructures docs into folders for Reference, Tutorials, and Explanation with index.rst files. Adds redirects and fixes a docs build issue. Currently awaiting initial review.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1012 docs: maintain reference quadrant rockcraft merged Merged documentation updates aligning the Explanation landing page with the model, standardizing labels, and updating reference titles and heading levels. Approved by two reviewers and merged despite a failing snap-test check.
75%
#2327 docs: fix some links charmcraft merged Merged a documentation update that corrected several broken links across two files. Approved by two reviewers, the changes were successfully integrated into the main branch, resolving navigation issues in the project documentation.
74%
#6 docs: Bring basic docs structure from starbase craft-archives merged Merged into main after addressing reviewer feedback. Added a basic documentation structure from starbase across seven files (+158 lines). Initially a draft, it was approved and merged to establish a starting point for project documentation.
74%
#1001 docs: maintain how-to quadrant rockcraft merged Merged following two reviewer approvals and successful CI checks. Changes reorganize the landing page, refine wording, rename sections, harmonize titles and anchors, and resolve a 12-factor intersphinx bug. Updated documentation is now live.
72%
#1002 docs: maintain the tutorial quadrant rockcraft merged Merged documentation update aligning the landing page with the model and adjusting tutorial titles and anchors. Approved by two reviewers, passed CI checks, and modified 21 files.
71%
#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.
71%
#5441 docs: revise home page snapcraft merged Merged documentation update revising the home page. Approved by two reviewers, rebased against a reorganized table of contents, and merged by maintainer medubelko.
71%
#668 Docs: Harmonize README with template rockcraft closed README updated to match the canonical/starbase template. Issue closed after resolution via pull request #881, which implemented the standardized documentation structure.
71%
#288 docs: consolidate external links rockcraft merged Merged documentation update consolidating external links. Approved by two reviewers, passed CI checks, and modified six files with 19 additions and 12 deletions.
71%
#1104 docs: update links craft-parts merged Merged after two reviewers approved. Updated documentation to fix broken links. Integrated into the main branch despite some CI test failures.
71%