← Back to issue list

docs: add doc tooling and layout from starbase

View original Github issue

Metadata

Project
craft-providers
Number
#296
Type
pull request
State
merged
Author
mr-cal
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #296 as commit 1e16ba5, adding documentation tox targets, a Diátaxis layout, README.rst, HACKING.rst, and minor reformatting.

Resolution: closed resolved

Reason: The documentation tooling and layout copied from Starbase were merged in commit 1e16ba5. The PR explicitly links the work to canonical/craft-providers#287.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? ----- A large copy-paste from [starbase](https://github.com/canonical/starbase) ### Changes - New `tox` targets for docs - diataxis front page (reorganization) - Minor doc reformatting (double backticks and line lengths) - `README.md` -> `README.rst` - `HACKING.rst` See https://github.com/canonical/craft-providers/issues/287. (CRAFT-1726)

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #296 as commit 1e16ba5, adding documentation tox targets, a Diátaxis layout, README.rst, HACKING.rst, and minor reformatting.
qwen/qwen3.6-35b-a3b — closed resolved PR #296 merged, adding documentation tooling and Diátaxis layout from canonical/starbase, including new tox targets and README.rst conversion.

Update history

Date Change
created

Related work

Related issues

Issue Project State Summary Similarity
#6 docs: Bring basic docs structure from starbase craft-archives merged Merged into main as b88fa8e: adds 158 lines across 7 files creating the initial Diataxis docs structure (docs/ with tutorials, how-to, reference, explanation, _dev, _templates) ported from starbase.
74%
#336 docs: fix some formatting errors in README starbase merged Docs-only PR merged as commit d3d4189, adding 10 lines to starbase's README to fix spacing/formatting errors that slipped past the earlier README cleanup in #331 (commit de0d308). Approved by 2 reviewers, no CI.
74%
#24 some general docs improvements starbase merged Merged in canonical/starbase#24, adding Sphinx linting and autobuild, strict docs builds, Ubuntu-font CSS, and renamed docs tox environments.
73%
#221 changelog is not included in the documentation craft-providers closed Documentation gaps were fixed by merged PR #296 (commit 1e16ba5), adding the changelog and Starbase-based docs tooling/layout with tox support; the maintainer confirmed all four concerns were addressed.
72%
#156 docs: update main project docs craft-cli merged Docs PR merged as commit 74150b7 by maintainer tigarmo: restored Starbase's HACKING.rst and updated README to point at it, ahead of the 2.0.0 release. HACKING.rst later gave way to CONTRIBUTING.md.
70%