Skip to content

docs(client): fix notifications.list README example to use real read option - #7194

Merged
os-help merged 1 commit into
mainfrom
claude/issue-6927-readme-unreadonly
Aug 10, 2026
Merged

docs(client): fix notifications.list README example to use real read option#7194
os-help merged 1 commit into
mainfrom
claude/issue-6927-readme-unreadonly

Conversation

@os-help

@os-help os-help commented Aug 10, 2026

Copy link
Copy Markdown
Collaborator

Fixes #6927

packages/client/README.md's only usage example for client.notifications.list showed { unreadOnly: true }. That key has never existed in the implementation — packages/client/src/index.ts declares the real options as { read?: boolean; type?: string; limit?: number }, and unreadOnly is read by nothing on either client or server. An author (or AI author) copying the example gets a silently ignored key and an unfiltered list.

Change

Replaced the example with the semantic equivalent using the real option:

-await client.notifications.list({ unreadOnly: true });
+await client.notifications.list({ read: false }); // unread only

Scope

Single-hunk, README-only change. Grepped all of packages/client for other unreadOnly occurrences — none found outside this one line.

No behavior change, no changeset needed (docs-only).

Generated by Claude Code


Generated by Claude Code

…option

The README's only usage example for client.notifications.list showed
{ unreadOnly: true }, a key the implementation has never read. The real
options are { read?, type?, limit? }; replace the example with
{ read: false } (the semantic equivalent of unread-only).

Fixes #6927
@vercel

vercel Bot commented Aug 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
objectstack Ignored Ignored Aug 10, 2026 2:27am

Request Review

@github-actions github-actions Bot added size/xs documentation Improvements or additions to documentation labels Aug 10, 2026
@github-actions

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

This PR changes 1 package(s): @objectstack/client.

11 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:

  • content/docs/ai/skills-reference.mdx (via packages/client)
  • content/docs/api/client-sdk.mdx (via @objectstack/client)
  • content/docs/api/data-flow.mdx (via @objectstack/client)
  • content/docs/api/environment-routing.mdx (via @objectstack/client)
  • content/docs/api/error-catalog.mdx (via @objectstack/client)
  • content/docs/getting-started/your-first-project.mdx (via @objectstack/client)
  • content/docs/kernel/runtime-services/data-service.mdx (via @objectstack/client)
  • content/docs/kernel/runtime-services/index.mdx (via packages/client)
  • content/docs/permissions/authentication.mdx (via @objectstack/client)
  • content/docs/plugins/packages.mdx (via @objectstack/client)
  • content/docs/protocol/kernel/realtime-protocol.mdx (via @objectstack/client)

3 release-owned page(s) also reference the affected code. These are read-only:

  • content/docs/releases/implementation-status.mdx (via @objectstack/client)
  • content/docs/releases/v16.mdx (via @objectstack/client)
  • content/docs/releases/v17.mdx (via @objectstack/client)

content/docs/releases/ is RELEASE-OWNED (AGENTS.md "Documentation Guardrails"): release
notes are written centrally at release time, and a code PR that edits them is the exact PR
that guardrail exists to stop. They are still audited — read-only. If one of them is actually
wrong, file an issue or open a dedicated docs-only PR; do not edit it here.

Advisory only. To re-verify, run the docs-accuracy-audit workflow scoped to these files:
node scripts/docs-audit/affected-docs.mjs origin/main → pass the list as args.docs.

@os-help os-help added skip-changeset PR has no user-facing published change; bypasses the changeset gate and removed documentation Improvements or additions to documentation labels Aug 10, 2026 — with Claude
@os-help
os-help marked this pull request as ready for review August 10, 2026 03:36
@os-help
os-help added this pull request to the merge queue Aug 10, 2026
Merged via the queue into main with commit e5ecc5e Aug 10, 2026
32 checks passed
@os-help
os-help deleted the claude/issue-6927-readme-unreadonly branch August 10, 2026 04:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/xs skip-changeset PR has no user-facing published change; bypasses the changeset gate

Projects

None yet

2 participants