Repository navigation
docs(site): sync RSR/privacy/cookbook docs, add contributing guide - #7
Merged
Merged
Conversation
5 of 6 tasks
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.
What
Brings the documentation site up to date with everything shipped in PRs #2-#6, and adds a Development section with a contribution guide. Website-only change (per repo rules, no product files touched).
Why
The docs site predated the recent work: RSR metric, privacy positioning, LangGraph/CrewAI cookbooks, and the contribution process existed only in the README/repo root. Roadmap WS-J spirit - keep
/docsmatching the product.How
Updated pages
max_recovery_step_ratioin the assertion example;--max-recovery-ratiorow (opt-in) in the CLI table.--explainoutput.max_recovery_ratio/max_recovery_step_ratiokeys in the TOML example.New category
05-Development/Testing
pnpm buildsucceeds; static/docsoutput contains the new sections ("Recovery Step Ratio", Development nav)make lintpass, 227 tests greenChecklist
make lintpassesuv run python -m pytestis green (227 passed)docs(site): sync RSR/privacy/cookbook docs, add contributing guide