← Back to issue list

docs: clarify how to build the documentation

View original Github issue

Metadata

Project
rockcraft
Number
#1197
Type
pull request
State
closed
Author
gcomneno
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

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
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 45
Complexity: 15
Confidence: 65
needs review Clarifies documentation build instructions, prerequisites, and linting commands. Currently awaiting maintainer review to potentially defer implementation until a standard documentation contribution model is established.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#500 docs: add diagrams craft-parts closed Closed without merging. The maintainer planned to restage the documentation diagrams after resolving build issues, but the pull request was ultimately abandoned.
71%
#503 docs: fix parts doc craft-parts closed Closed and abandoned because the documentation changes were already applied, resulting in an empty diff with zero lines changed. No merge occurred.
70%