make the doc's technical content dynamic
Metadata
Current evaluation
Implemented CI-tested dynamic technical documentation via merged PR #153 (commit 39d0d9ab).
Resolution: closed resolved
Reason: PR #153 was merged as commit 39d0d9ab, titled "docs: test technical documentation," and updates docs/tutorials.rst to address the request for tested documentation examples. The commit is directly associated with the tutorial documentation change.
Evaluated by: mr-cal-bot
No scores available.
Issue body
At the moment, we have a tutorial https://github.com/canonical/rockcraft/blob/main/docs/tutorials.rst with a technical example of a rockcraft.yaml file which is not only being maintained manually but not tested anywhere in the CI pipelines.
Examples and tutorials should be tested.
### Proposal
Make the technical contents of the documentation dynamic, by fetching the respective blocks of code from the project's `test` folder. Example: `docs/tutorials.rst` should use `tests/spread/tutorials/basic/`, where the actual tutorial YAML and tasks are described, and tested by Spread during the CI.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Implemented CI-tested dynamic technical documentation via merged PR #153 (commit 39d0d9ab). | |
| stealth/space-bunny-alpha | — | closed stale | Abandoned after maintainers agreed on a docs/code approach; no PR or commit implemented the CI-backed tutorial snippets. | |
| stealth/space-bunny-alpha | — | closed stale | Closed as abandoned after maintainers proposed CI-tested snippets under docs/code and task.yaml; no PR or commit implemented the plan. | |
| qwen/qwen3.6-35b-a3b | — | — | Abandoned after maintainer discussions outlined a plan to extract documentation code from a dedicated docs/code directory while keeping tests in task.yaml. No pull request was merged. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed without implementation. Maintainers approved a plan to source documentation code from a dedicated docs/code directory for CI testing, but no pull request was submitted to execute the changes. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed after maintainers agreed on a plan to organize documentation code in a dedicated docs/code directory. No PR was opened or merged, indicating the issue was likely abandoned or superseded. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed after maintainers agreed on a plan to organize test code under a docs/code directory mirroring test structures. No PR was merged, and the issue was abandoned pending future implementation. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
canonical/rockcraft#153
(confidence 99%)
Merged commit 39d0d9ab implements CI-tested dynamic technical documentation for the tutorial.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #153 test technical documentation | rockcraft | merged | Merged in PR #153 as 39d0d9ab: technical docs now reuse Spread-tested code blocks; READMEs and dependencies were updated and copybutton added. Fixes #54. |