Skip to content

📝 docs: fix stale documentation across 9 files for v0.10.0 namespace release#411

Merged
sodre merged 1 commit into
mainfrom
release-prep/334-close-epic
Feb 20, 2026
Merged

📝 docs: fix stale documentation across 9 files for v0.10.0 namespace release#411
sodre merged 1 commit into
mainfrom
release-prep/334-close-epic

Conversation

@sodre

@sodre sodre commented Feb 20, 2026

Copy link
Copy Markdown
Member

Summary

  • Fix 29 stale/inaccurate items across 9 documentation files to reflect v0.10.0 namespace changes
  • Update DynamoDB key patterns to include {ns}/ namespace prefix throughout docs
  • Correct exception hierarchy, CloudFormation outputs table, GSI projections, and CLI flag names
  • Add missing modules to API index (RepositoryBuilder, limits_cli, loadtest, visualization)
  • Update code examples in migrations docs to use Repository.open() and flat schema (no nested data.M)
  • Document -l flag format with period shorthand in CLAUDE.md
  • Add provisioner role component (prov) to IAM role naming docs

Test plan

  • Verify uv run mkdocs serve --livereload --dirty renders all updated pages without errors
  • Spot-check exception hierarchy in docs/api/exceptions.md matches src/zae_limiter/exceptions.py
  • Verify CloudFormation outputs table in docs/infra/cloudformation.md matches cfn_template.yaml
  • Confirm namespace-prefixed key patterns in docs/migrations.md examples are correct

Closes #334

🤖 Generated with Claude Code

- Fix exception hierarchy: move RateLimiterUnavailable under
  InfrastructureError, add ValidationError family (HIGH)
- Fix CLI flag: --enable-iam-roles → --create-iam-roles, default
  true → false (HIGH)
- Fix CloudFormation docs: GSI3 ALL → KEYS_ONLY, GSI2SK remove
  #{limit_name}, add 11 missing parameters, rebuild outputs table
  with 32 entries and conditions (MEDIUM-HIGH)
- Fix --audit-ttl-days → --audit-retention-days (MEDIUM)
- Add {ns}/ namespace prefix to auditing DynamoDB keys (MEDIUM)
- Fix bucket SK: #BUCKET#{resource}#{limit_name} → #BUCKET#{resource}
  in architecture docs (MEDIUM)
- Add missing modules to API index: repository_builder, limits_cli,
  loadtest/, visualization/ (LOW)
- Update 8 deprecated Repository() constructors to Repository.open(),
  fix nested data.M → flat attributes, add namespace prefixes to key
  patterns in migrations docs (LOW)
- Add prov role component and -l flag period suffix docs to
  CLAUDE.md (LOW)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@sodre sodre added this to the v0.10.0 milestone Feb 20, 2026
@sodre sodre added breaking Breaking change area/cli Command line interface area/infra CloudFormation, IAM, infrastructure api-design API surface changes area/limiter Core rate limiting logic area/aggregator Lambda aggregator function labels Feb 20, 2026
@sodre sodre marked this pull request as ready for review February 20, 2026 21:15
@sodre sodre merged commit cc9fd6a into main Feb 20, 2026
9 checks passed
@sodre sodre deleted the release-prep/334-close-epic branch February 20, 2026 21:26
@codecov

codecov Bot commented Feb 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 28.58%. Comparing base (d4bf8e0) to head (2ecedee).
⚠️ Report is 2 commits behind head on main.
✅ All tests successful. No failed tests found.

❗ There is a different number of reports uploaded between BASE (d4bf8e0) and HEAD (2ecedee). Click for more details.

HEAD has 3 uploads less than BASE
Flag BASE (d4bf8e0) HEAD (2ecedee)
unit 1 0
e2e 1 0
integration 1 0
Additional details and impacted files
@@             Coverage Diff             @@
##             main     #411       +/-   ##
===========================================
- Coverage   92.12%   28.58%   -63.55%     
===========================================
  Files          35       35               
  Lines        7672     7672               
===========================================
- Hits         7068     2193     -4875     
- Misses        604     5479     +4875     
Flag Coverage Δ
doctest 28.58% <ø> (ø)
e2e ?
integration ?
unit ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

Labels

api-design API surface changes area/aggregator Lambda aggregator function area/cli Command line interface area/infra CloudFormation, IAM, infrastructure area/limiter Core rate limiting logic breaking Breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

🎯 Multi-tenant namespace support: shared DynamoDB table with per-namespace isolation

1 participant