Skip to content

docs: sync documentation with current codebase state#534

Merged
nanotaboada merged 2 commits intomasterfrom
docs/sync-docs-with-codebase
Mar 22, 2026
Merged

docs: sync documentation with current codebase state#534
nanotaboada merged 2 commits intomasterfrom
docs/sync-docs-with-codebase

Conversation

@nanotaboada
Copy link
Owner

@nanotaboada nanotaboada commented Mar 22, 2026

Summary

  • README.md: update Features wording from "Copilot instructions"
    to "agent-optimized documentation" (Claude Code + GitHub Copilot)
  • CONTRIBUTING.md: add uv run prefix to lint commands; expand
    commit types to include docs, test, refactor, ci, perf
  • CHANGELOG.md: fix [unreleased] diff link (was pointing to
    v1.1.0-bielsa, now correctly points to v2.0.0-capello); add
    missing [2.0.0 - Capello] footer comparison link
  • .coderabbit.yaml: fix Pydantic v1 Config.alias_generator
    syntax to v2 ConfigDict(alias_generator=...); remove inaccurate
    async test functions claim; add ci and perf to commit types

Test plan

  • Verify CHANGELOG footer links resolve correctly on GitHub
  • Verify .coderabbit.yaml renders without schema errors

🤖 Generated with Claude Code


This change is Reviewable

README.md: update Features wording from Copilot to agent instructions
CONTRIBUTING.md: add uv run prefix to lint commands; expand commit
types to include docs, test, refactor, ci, perf
CHANGELOG.md: fix [unreleased] diff link (was v1.1.0-bielsa, now
v2.0.0-capello); add missing [2.0.0 - Capello] footer link
.coderabbit.yaml: fix Pydantic v1 Config syntax to v2 ConfigDict;
remove inaccurate async test claim; add ci and perf commit types

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Mar 22, 2026

Warning

Rate limit exceeded

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

⌛ 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

Run ID: 9be45dab-08e3-4f71-84bd-6fee1a80c3b5

📥 Commits

Reviewing files that changed from the base of the PR and between 939a91f and 6c48f11.

📒 Files selected for processing (4)
  • .coderabbit.yaml
  • CHANGELOG.md
  • CONTRIBUTING.md
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/sync-docs-with-codebase
  • 🛠️ sync documentation: Commit on current branch
  • 🛠️ sync documentation: Create PR
  • 🛠️ enforce http error handling: Commit on current branch
  • 🛠️ enforce http error handling: Create PR
  • 🛠️ idiomatic review: Commit on current branch
  • 🛠️ idiomatic review: Create PR
  • 🛠️ verify api contract: Commit on current branch
  • 🛠️ verify api contract: Create PR

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.

@sonarqubecloud
Copy link

@nanotaboada nanotaboada merged commit 5610bf1 into master Mar 22, 2026
9 checks passed
@nanotaboada nanotaboada deleted the docs/sync-docs-with-codebase branch March 22, 2026 02:46
@codecov
Copy link

codecov bot commented Mar 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (939a91f) to head (6c48f11).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #534   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines          113       113           
=========================================
  Hits           113       113           
Components Coverage Δ
Services 100.00% <ø> (ø)
Routes 100.00% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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