docs: initialise docs
Metadata
Current evaluation
Merged documentation initialization, establishing a basic ReadTheDocs structure with public PR builds and private main builds until content is added. Approved by two reviewers, passed all CI checks, and added 2225 lines across 14 files.
Suggested action: —
No scores available.
Issue body
Provides a basic setup that's ready for use but contains no content.
It's unlikely we'll ever need a tutorial, so I've left out that category.
PR builds are enabled and public on the RTD side. Main builds will remain private until we have content we want to make public.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation initialization, establishing a basic ReadTheDocs structure with public PR builds and private main builds until content is added. Approved by two reviewers, passed all CI checks, and added 2225 lines across 14 files. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation initialization establishing a basic, content-free repository structure. PR builds are configured as public on ReadTheDocs, while main builds remain private until substantive content is added. Tutorial sections were excluded. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #419 docs: update / remove duplicate content | rockcraft | merged | Merged to update and remove duplicate documentation, fixing issue #405. Approved by two reviewers despite ReadTheDocs build warnings about undefined labels. Reduced 57 lines across 5 files. | |
| #56 docs: add readthedocs yaml file | craft-parts | merged | Merged. Added a ReadTheDocs YAML configuration file to standardize documentation builds. Approved by two reviewers and passed CI checks. Introduces 25 lines of configuration without modifying existing code. | |
| #4258 docs: enable RTD builds | snapcraft | merged | Merged into main after approval and passing CI. The change enabled ReadTheDocs builds by adding documentation configuration to a single file. | |
| #920 docs: add 'about this documentation' | rockcraft | merged | Merged documentation update adding an 'about this documentation' section. Approved by two reviewers, passed CI checks, and introduced 86 lines across three files. | |
| #219 docs: fix readthedocs documentation generation | craft-parts | merged | Merged. Resolved ReadTheDocs build failures by installing missing environment packages, adding the changelog to the documentation index, and removing python-apt from setup to prevent version conflicts. Approved and passed CI. | |
| #163 docs: use Sphinx + Readthedocs | fetch-service | merged | Merged documentation migration to Sphinx using the canonical-sphinx extension and integrated ReadTheDocs for automated builds. Approved by two reviewers, modifying eight files with 206 additions and 102 deletions. | |
| #10 docs: improve README | snapcraft-rocks | merged | Merged documentation update improving the README. Approved by two reviewers, adding 66 lines and removing one across a single file. | |
| #387 docs: add readme template | starbase | merged | Merged after approval by two reviewers and successful CI checks. The pull request introduced a README template, adding 73 lines and removing 7 across two files to standardize project documentation. | |
| #31 docs: update main page with the standard template | craft-archives | merged | Merged documentation update applying the standard template to the main page. Approved by one reviewer, passed CI checks, and added 12 lines to one file with no coverage impact. | |
| #152 docs: add additional info to readme | craft-parts | merged | Merged documentation update adding README instructions for running tests, freezing requirements, generating local documentation, and commit guidelines. Approved by one reviewer, passed CI checks, and added 61 lines to a single file. |