docs: professional docs site, tested tutorial, LLM guide, better visuals#3
Merged
Conversation
- tested end-to-end tutorial (samples/tutorial.py + docs/tutorial.md), runs offline - thorough LLM-configuration guide (providers, keys, model selection, cost gating) - mkdocs Material docs site (mkdocs.yml + docs group), builds clean --strict; GitHub Pages deploy workflow; all internal doc links fixed - refined banner.svg + expanded generated diagram set (8) under docs/img/ - polished README quick start + docs index; new CONTRIBUTING.md Gate: ruff clean, pyright 0, mkdocs --strict ok, 93 tests pass (3 integration deselected).
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.
Documentation & developer experience
samples/tutorial.py) — guided tour (boot → load/validate → AutoML → GenAI feature engineering → agentic loop → serve), runs offline with no LLM key; a test guarantees it works.mkdocs.yml+docsgroup) — builds clean under--strict; GitHub Pages deploy workflow; all internal links fixed.assets/banner.svg+ 8 generated diagrams underdocs/img/.CONTRIBUTING.md.Gate: ruff clean · pyright 0 · mkdocs --strict ok · 93 tests pass (3 integration deselected).