← Back to issue list

add how-to guide for "building docs"

View original Github issue

Metadata

Project
rockcraft
Number
#123
Type
issue
State
closed
Author
cjdcordeiro
Labels
—
Created
Updated
Closed

Current evaluation

Added a guide for building Rockcraft documentation locally in PR canonical/rockcraft#126, merged as commit 68a7abda.

Resolution: closed resolved

Reason: PR canonical/rockcraft#126 added the requested documentation-building how-to and was merged as commit 68a7abda. The maintainer explicitly cited that PR when closing the issue.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Suggested by @evildmp , it would be nice to have an "how-to" guide for letting people how to build the docs locally. It isn't totally related to Rockcraft, but it would be helpful for developers+contributors.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Added a guide for building Rockcraft documentation locally in PR canonical/rockcraft#126, merged as commit 68a7abda.
stealth/space-bunny-alpha — closed resolved Added local documentation build instructions in merged PR #126, committed to main as 68a7abda.
stealth/space-bunny-alpha — closed resolved Added a how-to guide for building Rockcraft documentation locally in merged PR #126 (commit 68a7abda).
qwen/qwen3.6-35b-a3b — — Added a how-to guide for building documentation locally to assist developers. The request was fulfilled and closed via merged pull request #126.
qwen/qwen3.6-35b-a3b — — Added a how-to guide for building documentation locally. The request was fulfilled and closed via merged pull request #126.
qwen/qwen3.6-35b-a3b — — A how-to guide for building documentation locally was added. The request was resolved and closed via merged pull request #126.
qwen3.6-35b-a3b-mtp-q6 — — Closed after the requested local documentation build guide was implemented and merged in pull request #126. The update assists developers and contributors with the setup process.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/rockcraft#126 (confidence 100%)

    Merged PR that added the local documentation build guide in commit 68a7abda.

Related issues

Issue Project State Summary Similarity
#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.
83%
#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.
79%
#180 docs: add how-to guide for the rockcraft-pack GH action rockcraft merged Merged in canonical/rockcraft#180 (commit 70807c36), adding a how-to guide for configuring the rockcraft-pack GitHub Action in workflows.
78%
#1197 docs: clarify how to build the documentation rockcraft closed Closed unmerged; documentation-build clarifications were deferred until Rockcraft adopts its standard documentation contribution model.
77%
#1035 docs: add docs items to PR template rockcraft merged Merged in canonical/rockcraft#1035 (commit 051f40ba), adding documentation checklist items and a CONTRIBUTING.md link to the PR template.
76%
#105 docs: add commands rockcraft merged Merged PR #105 as commit 68906471, adding the first draft of rockcraft command documentation and resolving issue #101.
75%
#318 docs: automate CLI reference documentation rockcraft merged Merged PR #318 in commit ca1b1c20, automating Rockcraft's CLI reference documentation and implementing CRAFT-1779.
74%
#827 Docs: Tutorial setup maintenance rockcraft merged Merged in canonical/rockcraft#827 (commit be7862f8): tutorial setup docs split into two files by Rockcraft channel (latest/edge) and Docker steps split so `newgrp` no longer breaks copy/paste of the block.
72%
#802 docs: add remote build how-to to 1.8.0 release notes rockcraft merged Merged PR #802 via commit dc39bba8, adding a remote-build how-to reference to the Rockcraft 1.8.0 release notes.
72%
#559 docs: use canonical-sphinx rockcraft merged Merged PR #559 (commit 041e3137) switched Rockcraft docs to canonical-sphinx, added the dependency to setup.cfg, and regenerated requirements-doc.txt.
71%