Skip to content

docs(metadata-protocol,objectql): stop hardcoding the shared authoring-rule count in comments (#7491) - #8046

Merged
huangyiirene merged 1 commit into
mainfrom
claude/issue-7491-authoring-rules-count
Aug 12, 2026
Merged

docs(metadata-protocol,objectql): stop hardcoding the shared authoring-rule count in comments (#7491)#8046
huangyiirene merged 1 commit into
mainfrom
claude/issue-7491-authoring-rules-count

Conversation

@huangyiirene

Copy link
Copy Markdown
Collaborator

Fixes#7491

⚠️PR opened by the domain:metadata PM seat on the dev's behalf — branch pushed, no PR appeared, so the GitHub API is still unreachable from that container.

The defect

Comments hardcoded a count of the shared AUTHORING_RULES. The count was stale.

The card said two sites. The dev found threepackages/metadata-protocol/src/protocol.ts (×2) and packages/objectql/src/plugin.ts (×1). The brief asked it to verify that count rather than trust it, and verifying it was worth doing.

⭐ The fix removes the number rather than correcting it

The commit subject is the point: "stop hardcoding the shared authoring-rule count." A comment carrying a hand-maintained count of a registry will go stale again — that is what this card is. Correcting 26 to the current number would have re-armed the same trap for whoever reads it next.

Diff is 3 lines across 2 files. That is the whole change.

Why it was dispatched as the third concurrent editor of protocol.ts

Under the maintainer's mutually-exclusive-region exemption, this lane runs a per-hot-file editor cap. I raised it 2 → 3 this round (stated on #7491, 5266987227) because the queue's remaining cards all land in metadata-protocol — the lane was idle for lack of disjoint work, not work.

⇒ This card was chosen for the third slot precisely because it is a comment-only change: very nearly the smallest conflict surface available in an 11k-line file, and textually distant from the two sibling regions (#8027's sys_metadata overlay path, #7893's field write door). The brief told the dev to keep it that way and it did — no adjacent tidying, no reflow beyond the correction.

Anchoring note

The card cited protocol.ts:2632. That line number was stale three times over before this dispatch: it was already at :2698 on origin/main, then #7931 (7372d46) moved it, then #8015 (e3c8ed0) moved it again ~30 minutes before dispatch. The dev was told to find it by comment text, never by line number.

Changeset

None — a comment-only change releases nothing. ⚠️ If Check Changeset objects, the sanctioned route is the skip-changeset label (which the PM applies), ⛔ not a newly added empty-frontmatter changeset — those are rejected (#5471) because an all-empty set stalls the release silently and greenly (#4898).


Generated by Claude Code

…g-rule count in comments
Three comments asserted that `AUTHORING_RULES` holds 26 shared author-time
rules. The registry declares 38, so all three were wrong.
Rather than re-hardcode 38 — the same statement that just went stale — the
count is dropped and the registry is left as the authority ("all the shared
`AUTHORING_RULES`"). The sentences each turn on ALL of the rules being
disengaged, never on how many there are, so nothing is lost and the wording
cannot expire when rule 39 lands. This matches how the prose docs already
refer to the table (content/docs/deployment/validating-metadata.mdx), which
names the registry and its file and states no count.
Comment-only; no behaviour change.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019Uu3qrB98cMbJ48ae3z9S7
@vercel

vercelBot commented Aug 12, 2026

Copy link
Copy Markdown

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

1 Skipped Deployment
ProjectDeploymentActionsUpdated (UTC)
objectstackIgnoredIgnoredAug 12, 2026 1:28pm

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

This PR changes 2 package(s): @objectstack/metadata-protocol, @objectstack/objectql.

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

  • content/docs/concepts/metadata-lifecycle.mdx(via @objectstack/metadata-protocol, @objectstack/objectql)
  • content/docs/data-modeling/formulas.mdx(via packages/objectql)
  • content/docs/deployment/migration-from-objectql.mdx(via @objectstack/objectql)
  • content/docs/deployment/vercel.mdx(via @objectstack/objectql)
  • content/docs/kernel/contracts/data-engine.mdx(via @objectstack/objectql)
  • content/docs/kernel/runtime-services/examples.mdx(via packages/objectql)
  • content/docs/kernel/services-checklist.mdx(via @objectstack/metadata-protocol, @objectstack/objectql)
  • content/docs/kernel/services.mdx(via @objectstack/objectql)
  • content/docs/permissions/authentication.mdx(via @objectstack/objectql)
  • content/docs/permissions/system-context.mdx(via packages/objectql)
  • content/docs/plugins/index.mdx(via @objectstack/objectql)
  • content/docs/plugins/packages.mdx(via @objectstack/objectql)
  • content/docs/protocol/kernel/http-protocol.mdx(via @objectstack/metadata-protocol)
  • content/docs/protocol/kernel/index.mdx(via @objectstack/objectql)
  • content/docs/protocol/objectql/query-syntax.mdx(via packages/objectql)
  • content/docs/protocol/objectql/state-machine.mdx(via @objectstack/objectql)

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

  • content/docs/releases/implementation-status.mdx(via @objectstack/objectql)
  • content/docs/releases/v9.mdx(via @objectstack/metadata-protocol)

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.

@huangyiirenehuangyiirene added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Aug 12, 2026 — with Claude
@huangyiirene
huangyiirene marked this pull request as ready for review August 12, 2026 14:36
@huangyiirene
huangyiirene added this pull request to the merge queueAug 12, 2026
Merged via the queue into main with commit 9b959f3Aug 12, 2026
28 of 29 checks passed
@huangyiirene
huangyiirene deleted the claude/issue-7491-authoring-rules-count branch August 12, 2026 14:54
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/xsskip-changesetPR has no user-facing published change; bypasses the changeset gate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

finding: two code comments still say 26 shared AUTHORING_RULES — the live registry has 38

2 participants

@huangyiirene@claude