docs: clarify how to build the documentation
Metadata
Current evaluation
Closed unmerged; documentation-build clarifications were deferred until Rockcraft adopts its standard documentation contribution model.
Resolution: closed superseded
Reason: Maintainer asanvaq closed PR #1197 after stating the work would wait for the standard documentation contribution model. The proposed 11-line clarification was not merged, and the broader documentation-build request remains tracked in #627.
Evaluated by: mr-cal-bot
No scores available.
Issue body
## Summary
- clarify that the documented commands should be run from the repository root
- document the python3-venv prerequisite and that make setup-docs creates the docs virtual environment
- mention make docs-lint and how to inspect docs subproject targets from the docs/ directory
## Issue
- closes #627
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed superseded | Closed unmerged; documentation-build clarifications were deferred until Rockcraft adopts its standard documentation contribution model. | |
| stealth/space-bunny-alpha | — | closed superseded | Docs clarification PR closed unmerged; maintainer @asanvaq (2026-06-29) said the change will be absorbed into adopting the standard documentation contribution model. Issue #627 stays open. | |
| stealth/space-bunny-alpha | — | closed stale | Closed unmerged to defer the documentation build clarification until Rockcraft adopts its standard documentation contribution model. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed without merging. Maintainers deferred the documentation build clarifications until a standard contribution model is implemented, preferring to address the changes through a broader update instead. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed without merging. Maintainers deferred documentation updates until a standard contribution model is implemented, superseding this interim clarification. |
Update history
No update history recorded yet.
Related work
-
Related To:
rockcraft#627
(confidence 99%)
The PR explicitly targeted #627, where the broader documentation setup, build, and linting guidance remains tracked.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #732 build(deps): update doc requirements | rockcraft | closed | Closed unmerged as redundant after documentation requirements were refreshed separately in rockcraft#742 (commit 5d776281). | |
| #123 add how-to guide for "building docs" | rockcraft | closed | Added a guide for building Rockcraft documentation locally in PR canonical/rockcraft#126, merged as commit 68a7abda. | |
| #682 docs: fix typo | rockcraft | merged | Merged rockcraft#682 (commit 371bc723) fixing a one-line documentation typo; approved by 3 reviewers, CLA signed, merged. | |
| #627 Insufficient documentation on how to build Rockcraft's documentation | rockcraft | open | Rockcraft now documents fresh-environment documentation setup, builds, linting and PR submission, and tests the guide; the obsolete docs/installdocs workflow has been replaced. | |
| #254 docs: include contribution information | rockcraft | merged | Merged contribution documentation updates in rockcraft#254 via commit 24e0c3ab, changing 4 files (+84/-34) and approved by three reviewers. | |
| #247 docs: include some docs from craft-parts | rockcraft | closed | PR pulling craft-parts docs into rockcraft was left unmerged and closed as redundant; the same docs refactor landed instead via rockcraft#515 (commit 5c2263f1, "refactor(docs): use more docs from craft-parts"). | |
| #318 docs: automate CLI reference documentation | rockcraft | merged | Merged PR #318 in commit ca1b1c20, automating Rockcraft's CLI reference documentation and implementing CRAFT-1779. | |
| #800 docs: add remote-build how-to | rockcraft | merged | Merged docs PR canonical/rockcraft#800 (commit a07a6e6a) adding a remote-build how-to guide, +152 lines across 3 docs files, documenting the experimental `rockcraft remote-build` command. | |
| #300 docs: refactor documentation for sphinx-starter-pack | rockcraft | merged | Merged PR #300 in commit 66911e8e, refactoring 28 documentation files to align Rockcraft with sphinx-starter-pack and ease future integration. | |
| #289 docs: expand rockcraft.yaml reference | rockcraft | merged | Merged into main via commit 654c9c01, reorganizing reference docs and expanding the rockcraft.yaml configuration reference across seven files. |