Skip to content

docs: modernize theme, automate deployment, refresh content#64

Merged
HFooladi merged 1 commit into
mainfrom
docs/modernize-and-automate-deploy
Jul 15, 2026
Merged

docs: modernize theme, automate deployment, refresh content#64
HFooladi merged 1 commit into
mainfrom
docs/modernize-and-automate-deploy

Conversation

@HFooladi

Copy link
Copy Markdown
Owner

Summary

Modernizes the documentation UI/UX, automates deployment to GitHub Pages, and refreshes stale/missing content. The docs stack (Material for MkDocs 9.7 + mike) was already modern, but the live site was hand-deployed and stuck at 0.4.0, the CSS had real readability drags, and several pages had drifted from the API or were missing entirely.

Automated deployment

  • New .github/workflows/docs.yml using mike versioning:
    • GitHub release → deploy that version + move the latest alias
    • push to main → deploy a floating dev build
    • workflow_dispatch → deploy any version/alias (safe testing)
    • Correct for the branch-push Pages model: contents: write, fetch-depth: 0, serialized docs-deploy concurrency. Replaces manual mkdocs gh-deploy.
  • Removes .readthedocs.yaml so GitHub Pages is the single, versioned source of truth.

Modern, readable refresh

  • Rename custom-splito.cssthemap.css; flatten gradient header/footer/buttons to solid brand, soften the per-H2 underline, widen content to 54rem, bump nav/toc/table fonts + line-height, add a lighter dark-mode purple for contrast.
  • mkdocs.yml: add navigation.sections + content.tabs.link, enrich mkdocstrings options for scannable API pages, remove the placeholder G-XXXXXXXXXX analytics.

Content fixes

  • Landing + Getting Started lead with pip install themap; landing page gains badges and a hero banner (compressed to fit the repo's 1000 KB large-file hook).
  • New pages ported from the README: Run on Colab and Reproducing FS-Mol.
  • Rewrote working-with-tasks.md against the current API (fixed ~11 drifted calls: get_taskget_task_by_id, string folds → DataFold enum, task.moleculestask.molecule_dataset, protein via metadata_datasets["protein"], correct compute_*_distance signatures/result keys, added import random, constructor-based batching).
  • Removed orphaned docs/tutorials/Basics.ipynb.

Verification

  • mkdocs build --strict passes (same gate as CI's docs job); verified built output includes the new pages, hero image, renamed CSS, and no GA beacon.

Follow-up

After merge, cut a v0.5.0 GitHub release (or run the workflow via dispatch with version=0.5.0, alias=latest) to publish 0.5.0 docs and move latest off the stale 0.4.0.

🤖 Generated with Claude Code

Automate docs deployment and refresh the site's look and content.

- Add .github/workflows/docs.yml: mike-versioned deploy to gh-pages on
  release (updates `latest`), a `dev` build on push to main, and a
  workflow_dispatch path for safe testing. Replaces manual `mkdocs gh-deploy`.
- Modernize the theme: flatten gradient header/footer/buttons to solid brand,
  soften per-H2 rule, widen content to 54rem, bump nav/toc/table fonts and
  line-height, add a lighter dark-mode purple for contrast. Rename
  custom-splito.css -> themap.css.
- mkdocs.yml: add navigation.sections + content.tabs.link, enrich mkdocstrings
  options for readable API pages, remove placeholder GA property.
- Content: PyPI-first install on the landing and getting-started pages, add
  badges + hero banner to the landing page, add Colab-notebooks and
  FS-Mol reproduction pages (ported from README), rewrite the drifted
  working-with-tasks tutorial against the current API.
- Remove orphaned docs/tutorials/Basics.ipynb and .readthedocs.yaml
  (GitHub Pages is now the canonical, versioned docs site).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@HFooladi
HFooladi merged commit 93900fd into main Jul 15, 2026
9 of 11 checks passed
@HFooladi
HFooladi deleted the docs/modernize-and-automate-deploy branch July 15, 2026 14:55
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