Skip to content

Client documentation site (RTD) - #26

Merged
timtreis merged 17 commits into
mainfrom
docs/rtd-site
Oct 18, 2026
Merged

timtreis merged 17 commits into
mainfrom
docs/rtd-site

Conversation

@timtreis

Copy link
Copy Markdown
Member

Client documentation site for https://spatialdata-db.readthedocs.io (RTD project spatialdata-db).

Merge order: after #24 (RTD config; its commit is at the base of this branch) and after #25 (the docs describe the catalog-latest default and the fixed Catalog(version=...)).

What's in it:

  • Theme: scverse sphinx_book_theme with the DB's identity — site colour tokens for dark and light (follows the OS), SpatialData-DB wordmark + logo/favicon, header icons to the DB site / GitHub / Lamin, DB-coloured code highlighting (light-mode tokens darkened to ≥4.5:1 contrast).
  • Landing: live dataset count, git install line, a 5-line quickstart that loads the smallest Visium lung store (~10 MB), cards to the guides and API.
  • Introduction: spatial assays (one card per technology incl. legacy Spatial Transcriptomics, live counts + example links, any new technology listed generically) and a user-level "how the DB works" page (releases, validation/tiers, licenses, storage, versioning and drift — no byte-retention promise).
  • Guides: find & load, cohorts & reproducibility, ML / TaskAdapter (notebooks pre-executed against the live DB, small stores, outputs committed; RTD doesn't execute), CLI & MCP agents.
  • Reference: autosummary of sddb.__all__, CLI reference generated by Typer, MCP tools table, catalog-columns table generated from the schema, changelog. Tests fail if an export, CLI command or MCP tool goes undocumented.
  • Cite & license page + CITATION.cff (software; DB paper forthcoming).
  • Build-time stats come from the live catalog; if it's unreachable the pages render without numbers and the build stays green.
  • CI docs job (sphinx-build -W), gated in check.
  • Website links use one SITE_URL (currently https://spatialdata-db-web.pages.dev, since spatialdata-db.com isn't wired yet).
  • Also: README install line → git install; SpatialDataCohort.verify docstring corrected; gene-index size in CLI help (~260 MB).

tutorials/ is folded into the guides and removed.

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@read-the-docs-community

read-the-docs-community Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

@codecov

codecov Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.15%. Comparing base (64fadf0) to head (14962fc).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #26      +/-   ##
==========================================
+ Coverage   92.05%   92.15%   +0.10%     
==========================================
  Files          18       18              
  Lines        1460     1466       +6     
==========================================
+ Hits         1344     1351       +7     
+ Misses        116      115       -1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timtreis
timtreis merged commit 03bef1a into main Oct 18, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant