docs: adopt the shared documentation platform

[AlexanderFengler]

Summary

• standardize the Python 3.12 and uv documentation entry point with exact shared pins
• adopt the locally vendored Spine-authored Pages artifact workflow with narrow permissions and corrected src/lanfactory path filters
• make the documentation site canonical for durable guidance while keeping the README focused on identity and bootstrap
• repair rendered links in the canonical marimo tutorial sources and regenerate their documentation exports
• preserve the existing notebook execution workflow and the gh-pages branch as a rollback reference

Verification

• bash -n scripts/docs.sh
• ./scripts/docs.sh build
• pytest tests/test_notebooks.py --run-notebooks --no-cov -v: 4 passed
• Ruff check and format check: passed
• actionlint 1.7.12: passed
• rendered-site Lychee 0.24.2 check: 1,832 links, zero errors
• reusable workflow and four brand assets match the current HSSMSpine sources byte-for-byte
• no uv.lock or generated site output is tracked

Rollout

Pull requests and feature-branch manual runs can build and link-check but cannot deploy. Once this PR is approved and green, Pages will be switched from the preserved gh-pages source to GitHub Actions immediately before merge. We will then verify one automatic main deployment and one manual-main rendered-link deployment at the unchanged public URL.

Summary by CodeRabbit

• Documentation

  • Refreshed the README with clearer project overview, installation guidance, supported frameworks, documentation links, and contributor instructions.
  • Added HSSM ecosystem navigation links to the documentation footer.
  • Improved release announcement visibility and updated footer branding.
  • Updated ONNX export tutorials and links, including clearer export requirements and compatibility details.

• Chores

  • Improved documentation publishing reliability, scheduled link checking, and GitHub Pages deployment.
  • Added a simpler command for building or previewing documentation locally.
  • Updated documentation dependency configuration and link-check performance.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: bafd2285-b3fd-45d7-a0a7-741840784e6b

📥 Commits

Reviewing files that changed from the base of the PR and between 042722a and 7d17f87.

📒 Files selected for processing (15)

• .github/workflows/docs.yml
• .github/workflows/reusable-docs.yml
• .lychee.toml
• CLAUDE.md
• README.md
• docs/overrides/main.html
• docs/overrides/partials/ecosystem-links.html
• docs/styles/extra.css
• docs/tutorials/exporting_bayesflow_to_onnx.ipynb
• docs/tutorials/exporting_sbi_to_onnx.ipynb
• mkdocs.yml
• notebooks/exporting_bayesflow_to_onnx.py
• notebooks/exporting_sbi_to_onnx.py
• pyproject.toml
• scripts/docs.sh

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

The change adds a reusable documentation workflow, standardizes local documentation commands, updates the documentation site footer and release banner, and refreshes README and ONNX tutorial content.

Changes

Documentation refresh

Layer / File(s)	Summary
Reusable documentation workflow .github/workflows/docs.yml, .github/workflows/reusable-docs.yml	The main workflow invokes a reusable workflow. The reusable workflow validates profiles, builds documentation, checks links, uploads Pages artifacts, and deploys guarded releases.
Local documentation tooling and dependencies .lychee.toml, pyproject.toml, scripts/docs.sh, CLAUDE.md	Documentation dependencies and project URLs are updated. scripts/docs.sh now provides validated build and serve commands, and repository guidance uses the script.
Documentation site configuration and presentation mkdocs.yml, docs/overrides/*, docs/styles/extra.css	MkDocs excludes override files, controls the release announcement, and uses a styled ecosystem-links footer partial.
Documentation content and tutorial links README.md, docs/tutorials/*, notebooks/*	README content, ONNX export descriptions, documentation links, Marimo metadata, and rendered tutorial controls are updated.

Estimated code review effort: 4 (Complex) | ~45 minutes

Merge Risk: ⚪ Minimal · up to 7d17f

This PR updates the documentation platform, workflows, and rendered guidance without any identified merge-blocking correctness, security, or deployment risk; it is merge-ready after normal checks and review.

Sequence Diagram(s)

sequenceDiagram
  participant Contributor
  participant docs_yml as docs.yml
  participant reusable_docs as reusable-docs.yml
  participant MkDocs
  participant Lychee
  participant GitHubPages as GitHub Pages
  Contributor->>docs_yml: push, pull request, schedule, or manual dispatch
  docs_yml->>reusable_docs: invoke reusable documentation workflow
  reusable_docs->>MkDocs: install dependencies and build site
  reusable_docs->>Lychee: check rendered links when enabled
  reusable_docs->>GitHubPages: upload artifact and deploy on guarded events

Loading

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the pull request's primary change: adopting the shared documentation platform.
Docstring Coverage	✅ Passed	Docstring check was indeterminate for this PR — some files could not be analyzed in time. Not blocking.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch codex/docs-platform-migration

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.