Skip to content
This repository was archived by the owner on Mar 9, 2026. It is now read-only.

fix(docs): correct inaccuracies in README and boundary-validator references#70

Merged
roottool merged 4 commits intomainfrom
fix/doc-accuracy
Mar 5, 2026
Merged

fix(docs): correct inaccuracies in README and boundary-validator references#70
roottool merged 4 commits intomainfrom
fix/doc-accuracy

Conversation

@roottool
Copy link
Copy Markdown
Owner

@roottool roottool commented Mar 5, 2026 •
edited
Loading

Description

Fix three documentation inaccuracies found during a review of README and boundary-validator reference files.

Changes

README.md

  • Use bracket notation (result.data["username"]) in Quick Start example to comply with noUncheckedIndexedAccess; dot notation causes TS4111 in the project's TypeScript config

design-rules.md / validation-patterns.md

  • Fix Set<unknown> to Set<string> in correct-pattern code samples; FormData keys are always string per spec, matching the actual implementation

api-contract.md

  • Update versioning policy to reflect actual 0.x practice: minor version bumps are treated as effectively major (breaking changes allowed), consistent with v0.2.0 precedent

Type of Change

  • Bugfix (non-breaking change fixing an issue)
  • Security fix (non-breaking change addressing a security issue)
  • Documentation (changes to documentation only)
  • Refactoring (non-breaking change improving code structure)
  • Tests (adding or updating tests)
  • Tooling / CI (changes to build tools, CI configuration)

Boundary Checklist

  • This is a non-implementation change (Documentation, Tooling, or CI only)
  • No interpretation — Keys treated as opaque strings, no structural inference
  • No silent behavior — No merging, overwriting, or implicit resolution
  • Boundary respected — No validation, coercion, or business logic

📘 AGENTS.md

Security & API Stability

  • No security impact (forbidden keys, prototype safety unaffected)
  • No changes to public API (parse, ParseResult, ParseIssue, IssueCode)
  • No breaking changes; or justified with version bump rationale
  • Compatible with current v0.x versioning policy

Testing

  • bun run check:type:source passes
  • bun run test passes
  • bun run build passes

Signature

🤖 Generated with Claude Code

Co-Authored-By: Claude noreply@anthropic.com

@roottool
fix(docs): correct inaccuracies in README and boundary-validator refe…
4b3a7ae 
…rences

- README: use bracket notation for index signature access in Quick Start
  example (result.data["username"] instead of result.data.username)
- design-rules, validation-patterns: fix Set<unknown> to Set<string>
  in correct patterns; FormData keys are always strings per spec
- api-contract: update versioning policy to reflect actual 0.x practice;
  0.minor bumps are treated as effectively major (breaking changes allowed)
@roottool roottool self-assigned this Mar 5, 2026
@roottool roottool added the documentation Improvements or additions to documentation label Mar 5, 2026
roottool and others added 3 commits March 6, 2026 01:50
@roottool
fix(docs): align boundary-validator references with implementation
2399974 
- security-rules: use ReadonlySet + .has() instead of array + .includes()
  to match actual FORBIDDEN_KEYS implementation
- design-rules, validation-patterns, security-rules: update Last updated dates
@roottool
Merge branch 'main' into fix/doc-accuracy
416d2e4
@roottool
Merge branch 'main' into fix/doc-accuracy
3fa7874
@roottool roottool merged commit 9bc8a56 into main Mar 5, 2026
@roottool roottool deleted the fix/doc-accuracy branch March 5, 2026 17:03
@roottool roottool mentioned this pull request Mar 5, 2026
Merged
17 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

No reviews

Assignees

@roottool roottool

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@roottool