docs: restructure documentation using Diataxis framework#1118

Merged

benoit-cty merged 42 commits intomasterfrom

Apr 8, 2026

Commits on Apr 1, 2026

Initial plan

Copilot
authored and
benoit-cty
committed
docs: restructure documentation using Diataxis framework

authored and
benoit-cty
committed
docs: align content with Diataxis framework and improve narrative flow

authored and
benoit-cty
committed
docs(why.md): add Python and CLI quick-start examples

authored and
benoit-cty
committed
test: add mktestdocs-based tests for documentation code examples

authored and
benoit-cty
committed
docs: mark Prometheus/Logfire examples as non-testable and add missing imports

authored and
benoit-cty
committed
fix: remove unused import in test_docs_examples.py

authored and
benoit-cty
committed
fix: enable syntax highlighting in code examples

authored and
benoit-cty
committed
feat: add Comparing Model Efficiency tutorial with cross-links

authored and
benoit-cty
committed
docs: restructure navigation and add CLI quickstart

authored and
benoit-cty
committed
docs: improve Setup section readability and syntax highlighting

authored and
benoit-cty
committed
fix: use proper code block formatting for syntax highlighting

authored and
benoit-cty
committed
fix: use correct code block format without space

authored and
benoit-cty
committed
fix: use comment-based skip marker for code blocks

authored and
benoit-cty
committed
docs: add Logging group to How-to Guides

authored and
benoit-cty
committed
test: expand documentation coverage with additional files

authored and
benoit-cty
committed
feat: add framework-specific how-to guides and reorganize documentation

authored and
benoit-cty
committed
docs: add consistent headers and step-by-step structure to all how-to guides

authored and
benoit-cty
committed
docs: extract RAPL configuration into how-to guide with clear value proposition

authored and
benoit-cty
committed
docs: add Python section header to Quickstart tutorial for clarity

authored and
benoit-cty
committed
docs: add Python section header to homepage quickstart

authored and
benoit-cty
committed
docs: remove Python header from Quickstart Step 2

authored and
benoit-cty
committed
docs: move RAPL guide into Deployment group

authored and
benoit-cty
committed
bump
benoit-cty
committed
chore: format Python code with black and update uv.lock

authored and
benoit-cty
committed
fix: regenerate uv.lock to resolve scikit-learn dependency

authored and
benoit-cty
committed
chore: apply black formatting from pre-commit hook

authored and
benoit-cty
committed
Move contributing
benoit-cty
committed
Agent Instructions
benoit-cty
committed
security.md
benoit-cty
committed
AI Policy
benoit-cty
committed
CODE_OF_CONDUCT.md
benoit-cty
committed
Working with agents
benoit-cty
committed
doc link
benoit-cty
committed
Add Docker Sandbox
benoit-cty
committed

Commits on Apr 7, 2026

Fix link to latest version
benoit-cty
committed
update dep in GH Actions
benoit-cty
committed

Commits on Apr 8, 2026

Try to fix uv run
benoit-cty
committed