docs: landing redesign, design system, and page consolidation - #25
Merged
Conversation
New landing: hero pairing a real Config.yml with the three CLI commands, a file -> command -> outputs mental-model table with visible root keys, three pillar cards, intent-based next-step cards, a full documentation index, and the MICCAI proof strip. The stylesheet gains a two-theme token system aligned on the logo ink (teal brand voice, steel-blue machine voice, category hues) plus a global content-page layer: typed admonitions, tables, code blocks, toctree lists and page leads inherit the design automatically.
Merge eleven pages into their canonical homes: the usage workflow trio into the config guide (which gains Running-it sections), remote-server and the apps concept page into usage/apps, patterns into concepts/datasets, imaging-formats into the storage-backends reference, and contributing, architecture and usage/testing into development. Single-source the example and docker pages as includes of the repository READMEs. Every page now opens with a purpose lead and closes with pruned next-step links; section indexes gain reading-order guidance; all cross-references retargeted (build is free of broken-reference warnings).
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
Docs-only overhaul aimed at adoption: a redesigned landing, a site-wide design system, and a consolidation pass that removes duplicated pages so every topic has exactly one canonical home.
Landing & design system (
5f28219)index.rst): hero pairing a realConfig.ymlwith the three CLI commands; a file → command → outputs mental-model table with the root keys visible (Trainer:/Predictor:/Evaluator:); three pillar cards; intent-based next-step cards; a full documentation index; MICCAI proof strip._static/custom.css): two-theme token palette sampled from the logo ink — teal as the brand voice, steel blue as the machine voice (code surfaces only), violet/coral/amber as category hues. Dark mode follows Shibuya'shtml.darkplus aprefers-color-schemefallback.Consolidation & orientation (
55c9e7e)Eleven redundant pages merged into their canonical homes, with every unique fact preserved:
usage/{training,prediction,evaluation}config_guide/{…}(+ new Running it sections: commands,RESUME,-tb,--evaluations-dir)usage/remote-server,concepts/appsusage/apps(bundle anatomy + remote execution)config_guide/patternsconcepts/datasetsconcepts/imaging-formatsreference/components/storage-backendscontributing,architecture,usage/testingdevelopment(CI matrix, repository map, test loops)reference/api/public-apireference/api/indexexamples/segmentation,examples/synthesisandusage/dockerare now single-sourced as MyST includes of the repository READMEs — no more diverging copies.main(requirements install is opt-in, off by default).Verification
sphinx-buildpasses with zero broken-reference or orphan warnings (remaining warnings are the pre-existing autodoc import noise).Preview:
pixi run build-docsthen opendocs/build/html/index.html.