make the doc's technical content dynamic
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Abandoned after maintainers discussed extracting docs code into a docs/code folder for CI testing. No implementation or pull request was created. The proposal was reviewed but never executed. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #503 docs: fix parts doc | craft-parts | closed | Closed and abandoned because the documentation changes were already applied, resulting in an empty diff with zero lines changed. No merge occurred. |