Skip to content

docs: fact-check and refresh the project + site documentation#503

Merged
VforVitorio merged 1 commit into
devfrom
docs/update
Jul 18, 2026
Merged

docs: fact-check and refresh the project + site documentation#503
VforVitorio merged 1 commit into
devfrom
docs/update

Conversation

@VforVitorio

Copy link
Copy Markdown
Owner

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

  • Root: Python 3.10-3.12; correct F1-StratLab URLs; CLI defaults to lmstudio (not OpenAI); full CI job set + security workflows; INDEX.md now documents engine.py::run_lap (the shared per-lap pipeline) + the strategy router.
  • backend-api.md: real auth / rate-limit / /mcp layers, actual endpoints + 422-vs-500 split, removed a phantom auth router.
  • agents-api.md: new fix(agents): every LLM-facing tool except one accepts unvalidated free text #476 LLM input-validation section; full 14-field StrategyRecommendation table 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.
  • architecture.md: RaceState corrected to a per-lap single-driver snapshot.
  • simulation.md: dropped the dead Kafka / /ws/replay path.
  • ci-cd.md: branching diagram feature -> dev, release-please v5, missing jobs.
  • changelog / home / meet-the-author / roadmap: refreshed to the defended 10/10 project, 6 sub-agents, Babel dropped. Streamlit docs left accurate (v2 migration not done yet).

Flags for a human check (reviewers could not verify)

  • URL conflict: home.md/meet-the-author.md link f1stratlab.com while README.md links the GitHub-Pages subdomain.
  • Your current NTT DATA internship title (in meet-the-author.md).
  • Dead --provider CLI flag in src/arcade/main.py (code, not docs).

… 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).
@coderabbitai

coderabbitai Bot commented Jul 18, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a59c5608-f6d4-40d3-b2a5-d790e002198b

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/update

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added the area: docs Touches docs/, README, or other markdown label Jul 18, 2026
@VforVitorio
VforVitorio merged commit 61de410 into dev Jul 18, 2026
17 checks passed
@VforVitorio
VforVitorio deleted the docs/update branch July 18, 2026 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Touches docs/, README, or other markdown

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant