docs: reference docs for remote builds
Metadata
Current evaluation
Merged documentation update adding reference guides for remote builds, complementing autogenerated command docs and resolving issue #597. Approved with minor template discussion. Changes add 51 lines across two files.
Suggested action: —
No scores available.
Issue body
This is loosely inspired on the existing docs for Snapcraft, but with a different set of restrictions and no concerns about 'legacy' versus 'new' builders.
Note that this is complementary to the command reference that is autogenerated from the Python code.
Fixes #597
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adding reference guides for remote builds, complementing autogenerated command docs and resolving issue #597. Approved with minor template discussion. Changes add 51 lines across two files. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged reference documentation for remote builds, complementing autogenerated command references. Approved by reviewer, closing issue #597. Discussed potential RST template substitutions for app names. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation for remote builds, resolving issue #597. Changes complement autogenerated command references and were approved by @lengau following a brief discussion on template substitutions for app names. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #800 docs: add remote-build how-to | rockcraft | merged | Merged documentation update adding a remote-build how-to guide. Approved by three reviewers, the change adds 152 lines across three files detailing remote build procedures. | |
| #746 docs: add remote build how-to and reference docs | craft-application | merged | Merged documentation update adding remote build how-to and reference guides alongside a new common docs module. Approved by three reviewers and passed CI checks despite one failing snap-test. Modified 11 files with 411 additions and 6 deletions. | |
| #2702 docs: add common remote build pages | charmcraft | merged | Merged after being held in draft pending a hotfix. Added how-to and reference documentation for common remote builds. Approved by two reviewers and passed CI checks. | |
| #4882 docs: add explanation for remote build | snapcraft | merged | Merged documentation update detailing current and legacy remote builder behaviors. Approved by reviewers and passed CI. Resolves issue #4842 by establishing comprehensive guidance prior to future behavioral changes. | |
| #1118 docs: link corresponding reference to building remotely how-to | rockcraft | merged | Merged a documentation update linking the remote builds how-to guide to its reference page. Approved by two reviewers, the change addresses user feedback. A failing snap-test was dismissed as unrelated by a maintainer prior to merge. | |
| #802 docs: add remote build how-to to 1.8.0 release notes | rockcraft | merged | Merged documentation update adding a remote build how-to guide to the 1.8.0 release notes. Approved by one reviewer, passed CI checks, and modified one file with 13 additions and 4 deletions. | |
| #4267 docs: add command reference | snapcraft | merged | Merged after two approvals and passing CI. Added command reference documentation across 10 files. Required merging prerequisite PR #4272 to fix ReadTheDocs builds before updating the branch and finalizing the merge. | |
| #1003 docs: Add reference documentation for the RemoteBuildService | craft-application | open | Adds 121 lines of reference documentation for RemoteBuildService across 2 files. CI passing, no reviews or comments. Author is a maintainer. Service still exists in codebase; target docs file not yet in main. | |
| #5293 docs(release-notes): update remote-build notes | snapcraft | merged | Merged documentation update correcting release notes. Removed remote-build feature mention from version 8.7 as it is scheduled for 8.8. Approved by two reviewers, passed CI, and modified one file. | |
| #318 docs: automate CLI reference documentation | rockcraft | merged | Merged automated CLI reference documentation generation. Approved by three reviewers, passed CI checks, and updated five files. Implements CRAFT-1779 to streamline documentation updates. |