docs: documentation overhaul — component catalogue, API reference, landing - #20
Merged
Conversation
Add reference/components/ (models, losses & metrics, transforms, augmentations, schedulers, storage backends) documenting every component that can be referenced by name in YAML, with classpaths, constructor arguments and honest per-component maturity labels. Add reference/stability.md as the aggregated maturity matrix (Stable / Usable / Experimental / Broken-by-default), sourced from a code-level audit.
Add reference/python-api.md (KonfAIApp / KonfAIAppClient / bundle / ONNX export). Rewrite reference/app-server-api.md into the full endpoint contract (auth, multipart fields, job envelope, status enum, SSE, quotas, limits). Correct reference/cli.md (real TRAIN default is Config.yml, RESUME single-dash flags, device quirks, ONNX-export note) and wire the new pages into the reference toctree.
Add ecosystem/index.md (shipped vs in-progress map: konfai, konfai-apps, apps, SlicerKonfAI, KonfAI-MCP). Correctness fixes: imaging extra lists all five backends and add ssim/fid/export rows; correct the output key in custom-models to UNetBlock_0:Head:Conv; add [imaging] and a config-mutation warning to the quickstart; strip leaked Obsidian frontmatter from two concept pages.
Rewrite README.md as a tighter pitch that links out instead of duplicating the walkthrough, surfacing the component catalogue, apps and ecosystem, and keeping the KonfAI-MCP section. Turn the docs landing (index.rst) into a hero with navigation cards and an inline architecture diagram. Add transparent per-theme header logos derived from logo.png and the supporting CSS.
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
1 participant
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.
What
A documentation overhaul focused on making KonfAI easier to adopt, driven by a code-level audit of the whole package so the docs stay faithful to what actually ships.
New
reference/components/): models, losses & metrics, transforms, augmentations, schedulers, storage backends — every component referenceable by name in YAML, with classpaths, constructor arguments, and honest per-component maturity labels.reference/stability.md): aggregated Stable / Usable / Experimental / Broken-by-default view (e.g.DDPM,VoxelMorphatdim=3,ConvNeXtin 3D crash by default; various stubs flagged).reference/python-api.md):KonfAIApp/KonfAIAppClient/bundle/ ONNX export.ecosystem/index.md): shipped vs in-progress (konfai, konfai-apps, apps, SlicerKonfAI, KonfAI-MCP).Reworked
logo.png.Fixes (docs contradicting the code)
imagingextra lists all five backends; addssim/fid/exportrows.UNetBlock_0:Head:Conv(matches the shipped example).[imaging]and warns that a run rewrites the config.Config.yml), RESUME single-dash flags; strip leaked Obsidian frontmatter.Verification
Sphinx build is clean for these pages (no new toctree/cross-reference warnings; all new pages render). The pre-existing autodoc import warnings are unrelated (the
docsenv omits konfai's runtime deps).Notes
pixi.lockis intentionally excluded.