Skip to content

docs: fix all documentation issues#58

Merged
ajianaz merged 1 commit into
developfrom
docs/fix-documentation-v2
May 31, 2026
Merged

docs: fix all documentation issues#58
ajianaz merged 1 commit into
developfrom
docs/fix-documentation-v2

Conversation

@ajianaz

@ajianaz ajianaz commented May 31, 2026

Copy link
Copy Markdown
Collaborator

Fixes 15 documentation inaccuracies across README.md and CONTRIBUTING.md. Closes #57.

@ajianaz ajianaz added the documentation Improvements or additions to documentation label May 31, 2026
@coderabbitai

coderabbitai Bot commented May 31, 2026

Copy link
Copy Markdown

Warning

Review limit reached

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

More reviews will be available in 57 minutes and 59 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0a4fc5a1-b114-433e-aac6-542effc1343c

📥 Commits

Reviewing files that changed from the base of the PR and between 6d4774e and 99c7be2.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/fix-documentation-v2

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.

@ajianaz
ajianaz force-pushed the docs/fix-documentation-v2 branch from 54a4ac1 to 99c7be2 Compare May 31, 2026 10:53
@ajianaz
ajianaz merged commit 8e10a77 into develop May 31, 2026
1 of 2 checks passed
@ajianaz
ajianaz deleted the docs/fix-documentation-v2 branch May 31, 2026 10:53
@github-actions

Copy link
Copy Markdown

🔍 Cora AI Code Review

No issues found. Code looks good!

ajianaz added a commit that referenced this pull request May 31, 2026
…tructure (#58)

Co-authored-by: CTO Hermes <cto-hermes@users.noreply.github.com>
ajianaz added a commit that referenced this pull request Jul 16, 2026
…e) (#342)

Resolves the P3-core items from #334 — config values and profile values
were accepted without semantic checks, so typos and out-of-range values
propagated silently to runtime.

#94 — Config::validate() at load time:
  - temperature 0.0..=2.0, max_tokens/timeout >= 1
  - max_tokens_param, response_format, output.format, hook.mode/on_violation/min_severity
  - provider.base_url must have an http(s)/ws/unix scheme
  - multiple errors aggregated into one message

#81 — Profile::validate(): focus weight 1-10, recognized action/tone/detail_level

#57 — CategoryAction enum (case-insensitive deserialize): unknown values
  like 'blok' now fail loudly instead of silently becoming blocking

#58 — evaluate() forces Pass when enabled=false (disabled gate never fails)

#80 — deny_unknown_fields on all config sections: misspelled YAML keys
  (e.g. 'quailty_gate', 'temprature') rejected at parse time

24 new tests covering validation acceptance/rejection and deny_unknown_fields.
All 637 tests pass; clippy + fmt clean.

Refs #334
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant