← Back to issue list

docs: initialise docs

View original Github issue

Metadata

Project
starflow
Number
#81
Type
pull request
State
merged
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

Merged docs scaffold: 14-file Sphinx/Read the Docs setup (conf.py, index, .sphinx extension config) with no real content; tutorial category omitted by design. PR builds public, main builds private until content exists.

Resolution: closed resolved

Reason: PR #81 by medubelko was approved by 2 reviewers and merged as commit e9d205b ('docs: initialise docs') with all CI checks passing. Subsequent docs work built on this scaffold (#82, #99, #128, #144).

Evaluated by: mr-cal-bot

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
stealth/space-bunny-alpha — closed resolved Merged docs scaffold: 14-file Sphinx/Read the Docs setup (conf.py, index, .sphinx extension config) with no real content; tutorial category omitted by design. PR builds public, main builds private until content exists.
stealth/space-bunny-alpha — closed resolved Merged a 14-file documentation scaffold with no content, ready for use with Read the Docs and public PR builds.
stealth/space-bunny-alpha — closed resolved Merged #81, adding an empty Read the Docs structure with public PR builds and private main builds until content is ready.
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 work

  • Related To: starflow#99 (confidence 80%)

    Follow-up PR adding a how-to page, landing as f9c310f on top of this docs scaffold.

  • Related To: starflow#128 (confidence 75%)

    Later commit672388b documents the continuous deployment configured by this initial docs setup.

  • Related To: starflow#144 (confidence 60%)

    Latest touch to docs/conf.py (ef60ca0), meta description guidelines.

Related issues

Issue Project State Summary Similarity
#163 docs: use Sphinx + Readthedocs fetch-service merged Merged #163, migrating the documentation to a canonical-sphinx-based Sphinx project and connecting it to Read the Docs builds.
75%