Skip to content

docs: registry/storage accuracy notes + surface-freeze checklist step#412

Merged
johnleider merged 2 commits into
masterfrom
docs/doc-accuracy-fixes
Jun 29, 2026
Merged

docs: registry/storage accuracy notes + surface-freeze checklist step#412
johnleider merged 2 commits into
masterfrom
docs/doc-accuracy-fixes

Conversation

@johnleider

Copy link
Copy Markdown
Member

What

Documentation-accuracy fixes, each confirmed against source — no behavior changes (docs).

  • createRegistry (RegistryTicket.index JSDoc) — notes the lazy-reindex contract: a ticket read via values()/entries() immediately after unregister()/offboard() may carry a stale index until the next position-reading call (register/upsert/browse/lookup/move/reorder/seek) drains the deferred reindex.
  • useStorage (StorageContext.remove/clear JSDoc) — tightened to reflect actual scope: they act on keys accessed through this storage instance; keys persisted by a previous session but never read here are not removed. Drops the "all keys from storage" overstatement.
  • createRegistry docs — new FAQ entry: per-item teardown is O(n²) (each unregister is an O(n) locate+splice), so batch removals via offboard/clear and bound the mounted/registered count with createVirtual for large lists.
  • new-feature-checklist — adds the manual step to update packages/0/src/surface.test.ts (the public-surface freeze test) when a new public export is added — both tables + the bottom checklist.

Verification

pnpm typecheck:0 + pnpm build:docs — both green.

The checklist step references packages/0/src/surface.test.ts, which is added in #409. Merge #409 first (or together) so the referenced file exists on master.

@github-actions

Copy link
Copy Markdown
Contributor

⚠️ No changeset found

This PR changes packages/* source but has no changeset, so it won't be in the next release's version bump or notes. Add one:

pnpm changeset

Pick the affected package(s) — @vuetify/v0 carries @vuetify/paper automatically; @paper/genesis (and other @paper/* design systems) version separately — a bump type, and a short summary, then commit the generated .changeset/*.md. Docs-only, chore, or CI PRs can ignore this.

@pkg-pr-new

pkg-pr-new Bot commented Jun 29, 2026

Copy link
Copy Markdown

Open in StackBlitz

commit: 9b1dc1a

@johnleider johnleider added documentation Improvements or additions to documentation E: createRegistry Composable E: useStorage labels Jun 29, 2026
@johnleider johnleider added this to the v1.0.0 milestone Jun 29, 2026
@johnleider johnleider self-assigned this Jun 29, 2026
@johnleider johnleider merged commit 558d130 into master Jun 29, 2026
18 checks passed
@johnleider johnleider deleted the docs/doc-accuracy-fixes branch June 29, 2026 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation E: createRegistry Composable E: useStorage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant