test technical documentation
Metadata
Current evaluation
Merged in PR #153 as 39d0d9ab: technical docs now reuse Spread-tested code blocks; READMEs and dependencies were updated and copybutton added. Fixes #54.
Resolution: closed resolved
Reason: The approved PR was merged as commit 39d0d9ab, implementing CI-tested documentation snippets and explicitly fixing issue #54.
Evaluated by: mr-cal-bot
No scores available.
Issue body
fixes https://github.com/canonical/rockcraft/issues/54.
In this PR:
- restructure the docs to make them inherit the code-blocks from tested Spread tasks
- make Spread look into the docs code to test all documentation tutorials and how-to guides
- update READMEs
- simplify some of the python dependencies for the docs
- add `copybutton` to code-blocks
**NOTE:** for the `docs/how-to/code`, Spread will only run for one system (Jammy).
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in PR #153 as 39d0d9ab: technical docs now reuse Spread-tested code blocks; READMEs and dependencies were updated and copybutton added. Fixes #54. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged as 39d0d9ab: technical docs now reuse Spread-tested code blocks; READMEs and dependencies were updated and copybutton added. Fixes #54. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged after review approval. Restructured documentation to integrate Spread testing for tutorials and guides, updated READMEs, simplified dependencies, and added copybutton. Fixes issue #54. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Restructured documentation to integrate Spread testing for tutorials and guides, updated READMEs, simplified dependencies, and added copybutton. Resolves issue #54. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/rockcraft#54
(confidence 100%)
PR #153 explicitly identifies #54 as fixed by its merged documentation-testing changes.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #143 docs: make docs spread-testable | craft-store | merged | Merged PR #143 as commit 1676433, adding infrastructure to manually spread-test the restructured documentation without running docs spread tests in CI. | |
| #54 make the doc's technical content dynamic | rockcraft | closed | Implemented CI-tested dynamic technical documentation via merged PR #153 (commit 39d0d9ab). |