Uh oh!
There was an error while loading. Please reload this page.
docs(ui): tags IS read from src/docs frontmatter — correct the stale doc-pages callout - #11398
Merged
Merged
Conversation
…callout PR #10483 added an interim warn callout stating that `tags` cannot be set from a `src/docs/*.md` file. #10976 has since taught the collector to read it, so every sentence of that callout is now false and the page steers authors away from the path that works. Three sites in content/docs/ui/doc-pages.mdx, all verified against the merged collector rather than transcribed from the filing card: - the warn callout: replaced (not deleted — leaving nothing swaps one false statement for no steer at all) with the two accepted YAML spellings, the reported-not-dropped behaviour of anything else, the surfaces that raise `docs/frontmatter-tags`, the locale-variant rule, and the name-convention preference that survives as a preference; - the frontmatter table row: "not read from frontmatter" becomes frontmatter `tags:`, matching the `order:` / `group:` rows above it; - the "three scalars" sentence: `tags` is a list, not a scalar. Documentation only — no source file touched. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019siH5jDmk5hrayvfyojUqR
os-zhuang
marked this pull request as ready for review
August 23, 2026 15:49
Uh oh!
There was an error while loading. Please reload this page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes#10966
PR #10483 added an interim
warncallout tocontent/docs/ui/doc-pages.mdxstating thattagscannot be authored fromsrc/docs/*.mdfrontmatter. That was true when written.#10486 has since landed (merged PR #10976,
fix(cli): read doc tags from src/docs frontmatter, and report what it cannot read), so every sentence of the callout is nowfalse and the page actively steers authors away from the path that works.
Documentation only. No source file is touched.
Three sites, all re-derived rather than taken from the card's line numbers
:208)order:/group:rows above itwarncallout (:210-217)tagscannot be set from asrc/docs/*.mdfile today":303)order,group,tags)"orderandgroupscalars and thetagslist" —tagsis a listEvery clause of the new callout is traceable to the merged collector
The card drafted replacement wording before#10976 landed, so that draft was a
prediction of the fix rather than a description of it. Each clause was verified against
the code that actually merged; replacing a false statement with an unverified one would be
the same defect in different clothes.
tags: [tutorial, beginner], or a block of- itemlines under a baretags:packages/cli/src/utils/collect-docs.ts:128-163— inline branch requires the remainder to start[and end](:136-146); the block branch collects^-\s*(.*)$lines at any indent (:149-162)include: { tag }matches againstpackages/spec/src/system/book.zod.ts:243—Array.isArray(doc.tags) && doc.tags.includes(include.tag)docsentry place themselves the same waypackages/cli/src/utils/collect-docs.ts:616—const docs = [...inline, ...collected.docs], one merged setpackages/cli/src/utils/collect-docs.ts:122-126(thefrontmatterListdocblock's own "Deliberately NOT handled" list)docs/frontmatter-tagswarning quoting the spelling it foundpackages/cli/src/utils/collect-docs.ts:249-256—severity: 'warning',rule: 'docs/frontmatter-tags', message endsFound: ${unreadableTags}os lint,os validate,os compile;os buildis the same commandlint.ts:510→ printed underWarnings (N)atlint.ts:604-608and carried in--json;validate.ts:199→ text face at:293-295,--jsonat:313;compile.ts:352→printWarningat:366-371;packages/cli/src/commands/build.ts:5—class Build extends Compileos dev/os servecollect docs without linting them, so the warning does not appear therepackages/cli/src/commands/serve.ts:1608-1623— "Collection only (no lint-fail): docs are additive; never block boot",collected.issuesdiscarded;dev.ts:401-406spawns theservecommand<name>.<locale>.mdvariant declaringtags:raises the same rule; the tags must move to the base filepackages/cli/src/utils/collect-docs.ts:261-272— samedocs/frontmatter-tagsrule, distinct message, andDocTranslationItem(:31-35) carries only label/description/contentpackages/spec/src/system/doc.zod.ts:122-124— "Prefer a name convention (include: "crm_guide_*") when one exists — tags are for membership that cuts across naming"One nuance the card did not predict and the page therefore states carefully: the
locale-variant case and the unreadable-spelling case share the rule id
docs/frontmatter-tagsbut emit different messages, so the page says the variant "raisesthe same rule" rather than "gets the same warning".
Changeset
None, deliberately: this PR is documentation only and releases no package, which is the
repo's
skip-changesetcase (.github/workflows/pr-automation.yml:196-197— the labelmeans "this PR declares no release of its own"). The
skip-changesetlabel is applied onthis PR.
Verification
All 16 gate families derived by
node scripts/pm/dispatch-gates.mjs --repo objectstack-ai/objectstackfor this change set, pluscheck:nul-bytes, run as one unionat the final commit
f3a8fb90. Every one exit 0:Two of them (
check:doc-formula-expressions,check:doc-security-posture) were red onfirst run in the fresh worktree with
ERR_MODULE_NOT_FOUNDonpackages/lint/distand@objectstack/formula/dist— the unbuilt-dependency-closure trap, not this diff. Both aregreen above after
pnpm --filter '@objectstack/lint...' build.Repo-scale scans (
pnpm lint, the docs site build) are CI's run and are not claimed here.The
<name>.<locale>.mdplaceholder is inside an inline code span, the spelling thecorpus already uses in MDX (
content/docs/concepts/metadata-lifecycle.mdx:196,content/docs/deployment/cli.mdx:327).⛔ Draft on purpose. Not flipped ready, no auto-merge armed — the PM does that.
Generated by Claude Code