← Back to issue list

docs: updating homepage to new requirements

View original Github issue

Metadata

Project
rockcraft
Number
#1066
Type
pull request
State
merged
Author
asanvaq
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

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
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.
qwen3.6-35b-a3b-mtp-q6 Merged documentation update aligning the Rockcraft homepage with the 26.04 template. The author addressed reviewer feedback on whitespace and a link checker warning by adding the URL to linkcheck_ignore. All changes were implemented prior to merge.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#765 docs: fix explanation pages craft-parts merged Merged documentation update for Rockcraft and Craft Parts. Proofread explanation pages, fixed sections and links, and addressed undefined label warnings. Approved by three reviewers and integrated after confirming unrelated test failures.
77%
#634 feat: use versioned form of doc urls rockcraft merged Merged. Updates documentation URLs in error messages and rockcraft init templates to use versioned paths. Approved by two reviewers, passed CI, and modified eight files.
77%
#775 docs: apply release-notes template to rockcraft rockcraft merged Merged documentation update applying the starbase release-notes template to Rockcraft. Adds 257 lines across three files to render the template for the project. Approved by two reviewers.
76%
#323 docs: Add explanation on the Hello-world tutorial rockcraft merged Merged documentation update explaining the rockcraft.yaml file in the Hello World tutorial. Approved by three reviewers, the change adds 26 lines and removes 9 across two files.
74%
#1362 docs: Remove outdated report reference from why rockcraft page rockcraft merged Merged documentation changes removing a broken link to a deleted marketing report from the why rockcraft page, resolving issue #1360. Approved by one reviewer, passed all CI checks, and deleted three lines from one file.
74%
#310 docs: fix url of rockcraft format rockcraft merged Merged a documentation fix correcting a broken URL in convert-to-pebble-layer.rst, resolving a linkcheck failure. Approved by two reviewers, passed CI, and modified one file.
73%
#587 docs: add rockcraft chisel notes craft-parts merged Merged documentation update adding rockcraft chisel notes. Approved by two reviewers, the maintainer added nine lines to one file. Changes were integrated into the repository without CI checks or additional comments.
73%
#150 docs: add contributing file rockcraft merged Merged Rockcraft contribution guidelines. Added 17 lines to one file, approved by one reviewer, and completed with zero unresolved comments or CI failures.
72%
#32 docs: update README for published rocks snapcraft-rocks merged Merged documentation update reflecting that rocks are now published to GCR, eliminating the need for local builds. Approved by two reviewers with zero comments. Modified one file (+46/-19 lines).
72%
#289 docs: expand rockcraft.yaml reference rockcraft merged Merged after three reviewers approved, the PR reorganized the documentation reference section and expanded the rockcraft.yaml reference guide, modifying 7 files.
72%