Skip to content

docs: correct format validation counts - #55

Merged
davidkpiano merged 2 commits into
mainfrom
feature/daily-docs-audit-2026-10-13
Oct 14, 2026
Merged

davidkpiano merged 2 commits into
mainfrom
feature/daily-docs-audit-2026-10-13

Conversation

@davidkpiano

@davidkpiano davidkpiano commented Oct 13, 2026 •

Copy link
Copy Markdown
Member

Summary

  • remove the stale exact format count from the README after the adapter expansion
  • correct the base Mermaid native corpus from fourteen profiles to eight; six expanded profiles remain documented separately

Validation

  • pnpm verify (3,994 tests, typechecks, generated checks, conventions, build, publint, package smoke)
  • source assertions against both Mermaid fixture manifests (8 base + 6 expanded)
  • local-link scan: 57 Markdown files, 42 relative targets, no misses
  • git diff --check

No Changeset: documentation-only corrections.

Summary by CodeRabbit

  • Documentation
    • Updated the README’s tools description to state that adapters convert to and from both graph and diagram formats. The listed formats and other README claims remain unchanged.
    • Updated the Mermaid documentation to say that fixtures validate eight base diagram dialects, rather than fourteen scoped diagram dialects.

@coderabbitai

coderabbitai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b7ed3182-9b87-4984-a1c8-80fa8eea7e45
📥 Commits

Reviewing files that changed from the base of the PR and between cbba83b and d3dc7c8.

📒 Files selected for processing (2)
  • README.md
  • docs/native-validation.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • README.md
  • docs/native-validation.md

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

📝 Walkthrough

The README now describes conversion to and from graph and diagram formats. The Mermaid fixture documentation states that fixtures validate eight base diagram dialects.

Changes: Documentation wording

Layer / File(s) Summary
Format and dialect descriptions
README.md, docs/native-validation.md
The README describes conversion support for graph and diagram formats. The Mermaid fixture documentation changes the stated count from fourteen scoped dialects to eight base dialects.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to d3dc7

The wording updates appear mergeable after normal checks.

Pre-merge checks · Passed 5
Passed Passed checks (5 passed)
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the documentation changes that correct format validation counts in the README and Mermaid native validation documentation.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@davidkpiano
davidkpiano marked this pull request as ready for review October 13, 2026 08:39

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

@davidkpiano
davidkpiano merged commit a8a3a40 into main Oct 14, 2026
7 checks passed
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