feat(showcase): ADR-0046 — package docs coverage (flat src/docs/*.md)#1793
Merged
Conversation
Two cross-referencing docs demonstrating every doc-metadata authoring rule the build enforces — flat directory, namespace-prefixed filename stems, frontmatter-title vs first-heading title derivation, relative cross-references with anchors, code blocks keeping link syntax literal — plus a COVERAGE entry so the dimension is tracked like every other showcase feature. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
documentation
xuyushun441-sys
added a commit
that referenced
this pull request
Jun 13, 2026
…0046) (#1807) * docs(metadata): doc-type authoring guide + objectstack-ui skill coverage (ADR-0046) Package docs (ADR-0046) shipped framework-side (collection + render) and a showcase example (#1793), but the developer docs site and AI skills never mentioned the `doc` metadata type. Close that gap: - New guide content/docs/guides/metadata/doc.mdx — flat src/docs/*.md authoring, namespace-prefixed naming, the platform-level /docs/<name> routing model (no per-app/per-package URL nesting), cross-references, and the MDX/image build bans. - List `doc` in the metadata index table + sidebar (meta.json). - objectstack-ui skill: new "Docs — Package Documentation" section so AI agents author src/docs/*.md correctly (flat dir, prefix, CommonMark+GFM, link-don't-embed for dynamic content), plus description/tags coverage. Docs/skill only — no package code. Frontend /docs route + nav entry remain the objectui P2 follow-up. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * chore: empty changeset (docs/skill only, no package release) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Jack Zhuang <277994282+os-zhuang@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Adds the ADR-0046 dimension to the showcase: two cross-referencing docs under flat
examples/app-showcase/src/docs/that demonstrate (and are gated by) every authoring ruleos buildenforces — flat directory, namespace-prefixed filename stems (showcase_*), frontmattertitle:vs first-#-heading title derivation, relative cross-references with anchors (./showcase_docs_guide.md#cross-references), and code blocks keeping link syntax literal. ACOVERAGE.docsentry tracks the dimension alongside field types, chart types, etc.Follow-up to framework #1789/#1790 and objectui #1677.
Test plan
pnpm buildin app-showcase: both docs compile intodist/objectstack.json(showcase_indexwith first-heading label,showcase_docs_guidewith frontmatter label); ADR lint (flatness/prefix/links/MDX/image) passespnpm verify(typecheck) is currently broken on main by pre-existing issues unrelated to this change (reportsdrilldown, pagestemplate/isDefault, invoice formula — fields that gained.default()in recent spec PRs are required on the output types the example annotates with); tracked separately🤖 Generated with Claude Code