Skip to content

docs: sync README and wiki with code#65

Merged
jonathanperis merged 1 commit into
mainfrom
docs/readme-wiki-drift-audit
May 17, 2026
Merged

docs: sync README and wiki with code#65
jonathanperis merged 1 commit into
mainfrom
docs/readme-wiki-drift-audit

Conversation

@jonathanperis

Copy link
Copy Markdown
Owner

Summary

  • Audited README and Astro wiki pages against the current Rust source, Dockerfile, Compose files, SQL schema, and GitHub Actions workflows.
  • Updated stale implementation facts: API line count, Rust/Docker builder version, health endpoint, compose ports/resources, k6 modes, release image publishing, workflow triggers, and performance-source wording.
  • Added scripts/check_docs_drift.py and wired it into Build Check plus docs/package.json so future README/wiki drift is caught in PR CI.

Test Plan

  • python3 scripts/check_docs_drift.py
  • cd docs && bun run build
  • git diff --check
  • cargo build --release --manifest-path ./src/WebApi/Cargo.toml (blocked locally: OpenSSL development package/pkg-config unavailable in this container; CI runner has the expected build environment)

@coderabbitai

coderabbitai Bot commented May 17, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@jonathanperis has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 46 minutes and 24 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: f5c43e8a-bc40-4dd8-ace0-d4286c5975de

📥 Commits

Reviewing files that changed from the base of the PR and between a7ae740 and ab055ff.

📒 Files selected for processing (9)
  • .github/workflows/build-check.yml
  • README.md
  • docs/package.json
  • docs/wiki/architecture.md
  • docs/wiki/ci-cd-pipeline.md
  • docs/wiki/getting-started.md
  • docs/wiki/home.md
  • docs/wiki/performance.md
  • scripts/check_docs_drift.py
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-wiki-drift-audit

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 and usage tips.

@jonathanperis jonathanperis merged commit 384070e into main May 17, 2026
5 checks passed
@jonathanperis jonathanperis deleted the docs/readme-wiki-drift-audit branch May 17, 2026 05:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant