← Back to issue list

docs: refine landing pages

View original Github issue

Metadata

Project
snapcraft
Number
#5847
Type
pull request
State
merged
Author
jahn-junior
Labels
—
Created
Updated
Closed

Current evaluation

Docs-only PR by maintainer jahn-junior merged via commit 568986f6a: added Diátaxis category intros to the landing pages and created a new Explanation landing page (docs/explanation/index.rst), +90/-14 across 8 files.

Resolution: closed resolved

Reason: The pull request itself was merged into main as commit 568986f6a "docs: refine landing pages (#5847)", with all CI checks passing and two approving reviewers. The docs/explanation/index.rst landing page and the Diátaxis category introductions it added are present in the current tree.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [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`? - [ ] Have you successfully run `make test`? --- * Incorporate standard Diátaxis category introductions * Add a proper 'Explanation' landing page Sorry for the noise in the diff. I don't even realize I'm messing with the whitespace until I open the PR. :disappointed:

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Docs-only PR by maintainer jahn-junior merged via commit 568986f6a: added Diátaxis category intros to the landing pages and created a new Explanation landing page (docs/explanation/index.rst), +90/-14 across 8 files.
stealth/space-bunny-alpha — closed resolved Docs-only PR #5847 merged as commit 568986f6a (+90/-14, 8 files): added Diátaxis category introductions to the docs landing pages and a new proper 'Explanation' landing page.
stealth/space-bunny-alpha — closed resolved Merged PR #5847 as commit 568986f6a, refining landing pages with Diátaxis introductions and adding a proper Explanation landing page.
qwen/qwen3.6-35b-a3b — — Merged documentation updates refining landing pages. Changes incorporate standard Diátaxis category introductions and add a dedicated Explanation landing page. All CI checks passed and approvals were granted before merge.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation updates refining landing pages with standard Diátaxis category introductions and a new explanation page. Integrated into main without further review.

Update history

No update history recorded yet.

Related work

  • Related To: snapcraft#5858 (confidence 70%)

    Follow-up commit 551a793ae 'docs: use lists for all links in landing pages' extends the same landing-page work shortly after.

  • Related To: snapcraft#5446 (confidence 60%)

    Earlier commit 6c0500d7c 'docs: align landing pages with model' is the predecessor this PR refines.

Related issues

Issue Project State Summary Similarity
#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.
82%
#2272 docs: align landing pages with model charmcraft merged Merged PR #2272 aligned Charmcraft's tutorial, how-to, and reference landing pages with the standard Diátaxis model in commit c69f5dd7.
70%