Skip to content

chore(docs): README reflects expanded section-number grammar (#114–#117)#118

Merged
thewrz merged 1 commit into
mainfrom
chore/readme-section-number-expansion
Jun 6, 2026
Merged

chore(docs): README reflects expanded section-number grammar (#114–#117)#118
thewrz merged 1 commit into
mainfrom
chore/readme-section-number-expansion

Conversation

@thewrz

@thewrz thewrz commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

Summary

Test Plan

  • Docs-only — render check on GitHub; links to docs/adr/020-section-number-expanded-shape.md resolve

Out of Scope

No code changes. Pre-existing README nits unrelated to #114#117 (e.g. POST /parse bullet not mentioning .txt) left untouched.

Summary by CodeRabbit

  • Documentation
    • Updated development roadmap with new Phase 1c-ix milestone covering expanded section-number handling capabilities
    • Clarified cross-reference preservation behavior in extraction and parsing
    • Enhanced database documentation with seed counts and constraint specifications

@coderabbitai

coderabbitai Bot commented Jun 6, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 1a13738a-6dce-4572-8ecc-d4dd181e0e20

📥 Commits

Reviewing files that changed from the base of the PR and between 0d0cc78 and 1f3962d.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README documentation describing Phase 1c-ix expansion for section-number grammar (Level 4 dotted notation and Level 5 agency suffixes). Adds milestone status, documents DOCX and plaintext parser behavior, and clarifies database constraint enforcement across the expanded section-number shape.

Changes

Phase 1c-ix section-number grammar expansion

Layer / File(s) Summary
Phase 1c-ix milestone declaration
README.md
Adds new Phase 1c-ix status row documenting expanded section-number grammar support (Level 4 dotted + Level 5 agency suffixes) and that it spans parsers, inference, refs, API, and database layers.
Section-number handling implementation details
README.md
Updates DOCX cross-reference extraction documentation to preserve full CSI section identity including Level 4 dotted notation and Level 5 agency suffixes; updates plaintext .txt parser description to extract section/title using suffix-aware header scan over first 10 non-blank lines; expands Database section with seed data counts for CSI divisions (including Level 4/5 suffixes) and documents DB CHECK constraints enforcing the expanded grammar shape while leaving spec_references.target_spec_section deliberately unconstrained.

Possibly related PRs

  • wrzonance/SpecR#115: Implements expanded section-number handling using sectionNumberFragment() and normalizeSectionNumber() across refs, inference, and text parsers to prevent suffix truncation—the code changes that this README now documents.
  • wrzonance/SpecR#77: Prior Phase 1c documentation update to README covering DOCX/plaintext parsing work and related parsing behavior notes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 From README depths, a phase takes flight,
Level Four dots and suffixes bright,
Parsers now dance with grammar's might,
Database checks keep sections tight,
One-see-nine shines: the scope is right!

🚥 Pre-merge checks | ✅ 5
✅ 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 summarizes the main change: a README documentation update reflecting expanded section-number grammar across multiple related PRs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/readme-section-number-expansion

Comment @coderabbitai help to get the list of available commands and usage tips.

@thewrz thewrz merged commit a99298e into main Jun 6, 2026
4 of 5 checks passed
@thewrz thewrz deleted the chore/readme-section-number-expansion branch June 6, 2026 21:28
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