docs: fix documentation accuracy issues and add performance baseline - #162
Conversation
📝 WalkthroughWalkthroughThis PR adds a benchmark methodology and results document, expands the Unreleased changelog, and updates documentation for CLI behavior, output formats, programmatic usage, configuration defaults, XLIFF support, and validator examples. ChangesDocumentation and benchmark updates
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/configuration/schema.md`:
- Around line 59-60: Clarify the configuration documentation for the default
skip list and the interaction between validators: [] and skip: []. Update the
relevant validators and skip descriptions to state whether an omitted skip list
still excludes the documented default validators, and that an explicit empty
skip list enables every available validator.
In `@docs/reference/cli.md`:
- Around line 190-194: Update the fenced output block in the CLI documentation
to include an appropriate language identifier, such as text or console, while
preserving its displayed validation messages.
In `@PERFORMANCE.md`:
- Around line 17-18: Update the benchmark documentation’s Runs description to
explicitly state that memory_get_peak_usage(true) reports the process-level
high-water mark across all five back-to-back runs, since gc_collect_cycles()
does not reset it. Do not describe the value as an independent per-run peak
unless the benchmark is changed to isolate or reset measurements.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: aaff29be-e83a-46cd-b6b9-f0b12b7ded07
📒 Files selected for processing (8)
CHANGELOG.mdPERFORMANCE.mddocs/configuration/schema.mddocs/index.mddocs/reference/cli.mddocs/reference/file-formats.mddocs/reference/programmatic-usage.mddocs/reference/validators.md
Summary
mainthat were missing release notesKeyNamingConventionValidatoris now opt-in, same asDuplicateValuesValidator)ValidationResultJsonRendererat allline/col/titleparams, and document exit-code behavior under--strictValidationResult/Issue(hasErrors(),getIssues(),getFilePath())-d testsflag in a copy-pasteable examplePERFORMANCE.mdwith a before/after benchmark comparingmainprior to and after the 22 merged PRs (~25% faster, ~12.5% less peak memory)Changes
CHANGELOG.md- Add missing entries for merged fix/perf PRsdocs/configuration/schema.md- Correctskipoption default valuedocs/index.md- MarkKeyNamingConventionValidatoras opt-indocs/reference/cli.md- Rewrite JSON/GitHub output examples, document--only/--skipvalidation errors and--strictexit-code behaviordocs/reference/programmatic-usage.md- Replace broken example with the actualValidationResultAPIdocs/reference/validators.md- Fix console-output wording and test commandsdocs/reference/file-formats.md- Document XLIFF 2.0 supportPERFORMANCE.md- New before/after performance reportSummary by CodeRabbit
Performance
Security & Bug Fixes
Documentation