Skip to content

docs: close code and documentation audit gaps#71

Merged
jonathanperis merged 1 commit into
mainfrom
docs/close-documentation-gaps
May 29, 2026
Merged

docs: close code and documentation audit gaps#71
jonathanperis merged 1 commit into
mainfrom
docs/close-documentation-gaps

Conversation

@jonathanperis
Copy link
Copy Markdown
Owner

Summary

  • Add an API Reference page covering request/response payloads, validation rules, status codes, and the current over-limit debit behavior
  • Update README and Pages docs to point at the canonical Pages documentation and document Astro 6.4/Sätteri docs pipeline
  • Clarify API-vs-PostgreSQL responsibilities, benchmark report methodology, CI build matrix, and report archive semantics
  • Align NGINX config comments and prod README with documented behavior

Validation

  • NODE_ENV=production bun run build
  • bun run lint
  • Generated docs link check: 0 missing internal links

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 29, 2026

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 51 minutes and 30 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: ccda8f7c-d865-4b0c-abfa-e6da034a0559

📥 Commits

Reviewing files that changed from the base of the PR and between f55dffa and e74f122.

📒 Files selected for processing (15)
  • README.md
  • docs/README.md
  • docs/src/pages/docs/[...slug].astro
  • docs/src/pages/reports/index.astro
  • docs/src/sidebar.config.ts
  • docs/wiki/api-reference.md
  • docs/wiki/architecture.md
  • docs/wiki/challenge.md
  • docs/wiki/ci-cd-pipeline.md
  • docs/wiki/getting-started.md
  • docs/wiki/home.md
  • docs/wiki/performance.md
  • nginx.conf
  • prod/README.md
  • prod/conf/nginx.conf
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/close-documentation-gaps

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 f01fcf4 into main May 29, 2026
5 checks passed
@jonathanperis jonathanperis deleted the docs/close-documentation-gaps branch May 29, 2026 23:03
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