Skip to content

docs: document source-backed API behavior#69

Merged
jonathanperis merged 1 commit into
mainfrom
docs/source-backed-audit-updates
May 29, 2026
Merged

docs: document source-backed API behavior#69
jonathanperis merged 1 commit into
mainfrom
docs/source-backed-audit-updates

Conversation

@jonathanperis

Copy link
Copy Markdown
Owner

Summary

  • Audited README and Astro Pages wiki against the current Rust API, SQL dump, Docker Compose, docs tooling, and workflows.
  • Documented previously implicit source-backed behavior: PascalCase DTO aliases, seeded client limits, over-limit debit handling, and local InfluxDB/Grafana env requirements.
  • Extended the docs drift guard so those source-backed facts stay covered by CI.

Audit findings addressed

  • The API accepts both lowercase challenge fields and PascalCase aliases (Valor, Tipo, Descricao), but docs only described lowercase fields.
  • The five seeded client limits are present in both Rust and SQL but were not documented in the API contract.
  • The stored procedure currently returns unchanged balance with a 200 response for over-limit debits rather than documenting that behavior explicitly.
  • Local k6/observability needs .env values for INFLUXDB_PASSWORD and INFLUXDB_TOKEN, but quick-start stress-test docs skipped that setup.
  • docs/README.md did not mention the Astro 6/Sätteri/Bun/Node runtime shape.

Validation

  • python3 scripts/check_docs_drift.py
  • cd docs && bun run lint
  • cd docs && bun run build
  • git diff --check

@coderabbitai

coderabbitai Bot commented May 29, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@jonathanperis, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 58 minutes and 50 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, 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 include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 797b4a89-bfcb-48aa-a55c-cb18f99cbddf

📥 Commits

Reviewing files that changed from the base of the PR and between 6dc3805 and 2ba6404.

📒 Files selected for processing (6)
  • README.md
  • docs/README.md
  • docs/wiki/architecture.md
  • docs/wiki/getting-started.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/source-backed-audit-updates

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 07ead4b into main May 29, 2026
5 checks passed
@jonathanperis jonathanperis deleted the docs/source-backed-audit-updates branch May 29, 2026 22:57
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.

2 participants