docs: modernize theme, automate deployment, refresh content#64
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
.github/workflows/docs.ymlusing mike versioning:latestaliasdevbuildcontents: write,fetch-depth: 0, serializeddocs-deployconcurrency. Replaces manualmkdocs gh-deploy..readthedocs.yamlso GitHub Pages is the single, versioned source of truth.Modern, readable refresh
custom-splito.css→themap.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: addnavigation.sections+content.tabs.link, enrich mkdocstrings options for scannable API pages, remove the placeholderG-XXXXXXXXXXanalytics.Content fixes
pip install themap; landing page gains badges and a hero banner (compressed to fit the repo's 1000 KB large-file hook).working-with-tasks.mdagainst the current API (fixed ~11 drifted calls:get_task→get_task_by_id, string folds →DataFoldenum,task.molecules→task.molecule_dataset, protein viametadata_datasets["protein"], correctcompute_*_distancesignatures/result keys, addedimport random, constructor-based batching).docs/tutorials/Basics.ipynb.Verification
mkdocs build --strictpasses (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.0GitHub release (or run the workflow via dispatch withversion=0.5.0, alias=latest) to publish 0.5.0 docs and movelatestoff the stale 0.4.0.🤖 Generated with Claude Code