Insufficient documentation on how to build Rockcraft's documentation
Metadata
Current evaluation
Docs gap: building Rockcraft's docs locally wasn't documented (make installdocs failed on fresh env). The build-docs how-to page now documents the current setup-docs/docs workflow, so the core request appears addressed; a contributor recently asked to be assigned.
Suggested action: keep open
Reason: The reported `make installdocs` failure is obsolete: the docs Makefile was refactored (starter pack refresh #1112, sphinx stack 2.0 #1252) and the build-docs how-to page now documents `make setup-docs` / `make docs` / `make docs-auto` with a spread test (docs/how-to/code/build-docs/task.yaml) verifying a clean-tree build. However, the issue is unlabelled, the reporter's extra ask (a PR-contributing section) is unaddressed, and @gcomneno asked to be assigned 167 days ago with no maintainer response, so it still needs triage/acknowledgement rather than closure.
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.8-27b |
Impact:
30
Quick Win:
24.0
Staleness:
55
Complexity:
20
Confidence:
70
Support Request:
10
|
keep open | Docs gap: building Rockcraft's docs locally wasn't documented (make installdocs failed on fresh env). The build-docs how-to page now documents the current setup-docs/docs workflow, so the core request appears addressed; a contributor recently asked to be assigned. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
65
Complexity:
20
Confidence:
85
Support Request:
30
|
needs triage | Unlabeled documentation request asking for clear instructions to build Rockcraft docs locally. Currently fails due to missing virtual environment setup. Awaiting maintainer review and assignment. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
80
Complexity:
10
Confidence:
85
Support Request:
10
|
needs triage | Contributor requests clearer local documentation build instructions, noting missing virtualenv setup steps. The issue remains open with no maintainer labels or responses, and an external contributor recently volunteered to address it. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
70
Complexity:
15
Confidence:
85
Support Request:
10
|
needs triage | External contributor requests clearer instructions for building Rockcraft documentation locally. Issue lacks labels and maintainer response, with a recent comment from another contributor asking to be assigned. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
75
Complexity:
10
Confidence:
85
Support Request:
10
|
needs triage | Rockcraft documentation lacks clear local build instructions, causing environment setup failures. Requests explicit steps for prerequisites, commands, and workflow. Currently open and awaiting assignment. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
rockcraft#1112
(confidence 75%)
build(docs): refresh starter pack implementation rewrote the docs Makefile (setup-docs/docs targets, .venv) and updated the build-docs how-to, replacing the broken `make installdocs` flow the issue cites.
-
Related To:
rockcraft#1252
(confidence 60%)
docs: update dependency sphinx stack to 2.0 further changed the docs build toolchain referenced by the build-docs page.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #101 docs for `rockcraft clean` | rockcraft | closed | Documentation for the rockcraft clean command was requested alongside a pull request. The contributor committed to adding the missing docs, and the ticket was closed pending completion. | |
| #1051 docs: TYPE YOUR QUESTION HERE | rockcraft | closed | Broken documentation link fixed. Contributor reported a 404 redirect for Rockcraft docs. Maintainer updated the URL to the correct stable path and closed the issue. | |
| #406 fix(docs): drop "--edge" from rockcraft install instructions | rockcraft | merged | Merged a documentation fix removing the "--edge" flag from rockcraft installation instructions, resolving issue #404. Approved by three reviewers, passed CI, and updated five files. |