docs: fact-check and refresh the project + site documentation#503
Merged
Conversation
… the current code Three parallel reviewers verified every claim, command, path, signature and example against the actual code before editing (this repo's standing lesson: docs must not 'teach the bugs'). Root docs: Python 3.10-3.12, correct F1-StratLab URLs, CLI defaults to lmstudio not OpenAI, the full CI job set + security workflows, and INDEX now documents src/strategy/inference/engine.py::run_lap (the shared per-lap pipeline) + the strategy router. docs.f1stratlab.com pages: backend-api rewritten (real auth/rate-limit/mcp layers, actual endpoints + error split, removed a phantom auth router); agents-api gained the #476 LLM input-validation section + the full 14-field StrategyRecommendation table incl the #433 clamp + vsc_active; architecture corrects RaceState to a per-lap single-driver snapshot; simulation drops the dead Kafka/ws-replay path; ci-cd fixes the branching diagram (feature -> dev) + release-please v5; changelog refreshed verbatim from root; home/meet-the-author/roadmap reflect the defended 10/10 project + 6 sub-agents + Babel dropped. Streamlit docs left accurate/untouched (v2 webapp migration is in progress, not done).
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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.
Three parallel reviewers audited the project docs (root) and the docs.f1stratlab.com site (
docs/pages/), verifying every claim/command/path/signature/example against the current code before editing — the repo's standing rule that docs must not 'teach the bugs'. 22 files, +856/-159.Highlights
F1-StratLabURLs; CLI defaults tolmstudio(not OpenAI); full CI job set + security workflows;INDEX.mdnow documentsengine.py::run_lap(the shared per-lap pipeline) + the strategy router./mcplayers, actual endpoints + 422-vs-500 split, removed a phantomauthrouter.StrategyRecommendationtable incl the Strategy: expected_stint_end is unvalidated LLM free text (can exceed the system's own tyre capacity) #433 clamp +vsc_active; fixed a fabricated tire warning level.RaceStatecorrected to a per-lap single-driver snapshot./ws/replaypath.feature -> dev, release-please v5, missing jobs.Flags for a human check (reviewers could not verify)
home.md/meet-the-author.mdlinkf1stratlab.comwhileREADME.mdlinks the GitHub-Pages subdomain.meet-the-author.md).--providerCLI flag insrc/arcade/main.py(code, not docs).