← Back to issue list

docs: import package repositories docs from snapcraft

View original Github issue

Metadata

Project
craft-archives
Number
#12
Type
pull request
State
merged
Author
tigarmo
Labels
—
Created
Updated
Closed

Current evaluation

PR merged as 62ad299, importing Snapcraft package-repositories docs into craft-archives sphinx docs, plus Ubuntu font CSS, sphinx-lint, and a rundocs target (CRAFT-1551).

Resolution: closed resolved

Reason: The PR was approved by one reviewer and merged into main as commit 62ad299 ("docs: import package repositories docs from snapcraft (#12)"), which appears in the docs path history alongside follow-ups like 130845c "docs: use Ubuntu font". The package repositories docs, sphinx-lint integration, and rundocs target all landed as described.

Evaluated by: mr-cal-bot

No scores available.

Issue body

This PR adds the Package Repositories docs [from snapcraft](https://snapcraft.io/docs/package-repositories) in Diátaxis format. I started experimenting with documenting the properties in the pydantic models but I wasn't 100% happy with the end result (too noisy for both dev and end-user), so this just adds the docs as regular rst/sphinx. Also did some drive-by changes: - Add some CSS from rockcraft to use Ubuntu font; - Un-comment sphinx-lint and add it as a regular linter; - Add a `rundocs` target that uses `sphinx-autobuild` to set up a server to update the docs on-the-fly. CRAFT-1551

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved PR merged as 62ad299, importing Snapcraft package-repositories docs into craft-archives sphinx docs, plus Ubuntu font CSS, sphinx-lint, and a rundocs target (CRAFT-1551).
stealth/space-bunny-alpha — closed resolved Merged PR #12 as 62ad299, importing Snapcraft package-repositories docs and adding Ubuntu font CSS, sphinx-lint, and a rundocs target.
stealth/space-bunny-alpha — closed resolved Merged as 62ad299 via #12, importing Snapcraft package-repository docs in Diátaxis format and adding Ubuntu-font CSS, sphinx-lint, and a rundocs autobuild target.
qwen/qwen3.6-35b-a3b — — Merged following approval. Imports package repositories documentation from snapcraft. Adds Ubuntu font CSS, enables sphinx-lint, and introduces a sphinx-autobuild documentation server target. Resolves CRAFT-1551.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/craft-archives#14 (confidence 60%)

    Docs commit26ecef9 landing immediately after this PR, part of the same early docs setup effort.

  • Related To: canonical/craft-archives#3 (confidence 55%)

    Earlier PR moving snapcraft.repo code into craft_archives; same code provenance but not a replacement for this docs import.

Related issues

Issue Project State Summary Similarity
#4 move repo code craft-archives merged Merged PR #4, moving repository code from Snapcraft into craft-archives after approval; the recreated import landed in commit 31da2f9.
74%
#3647 repo: add package repository handling (CRAFT-846) snapcraft merged Merged package repository and PPA definitions/helpers into snapcraft 7.0 via #3647, porting code from #2911, #3341, #3359, and #3363.
72%
#4635 feat(docs): pull in content from craft-parts snapcraft merged Merged #4635, importing craft-parts documentation into Snapcraft across 21 files; landed as commit 055a93543 after three approvals.
70%
#3 move "repo" code from snapcraft craft-archives closed Merged PR #3 moved snapcraft.repo into craft_archives, adapting logging, errors, utilities, tests, and linting; commits 31da2f9 through 3cb8d7c implemented it.
70%