docs(metadata): doc-type authoring guide + objectstack-ui skill (ADR-0046)#1807
Merged
Conversation
…age (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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
documentation
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.
What
ADR-0046 (package docs as metadata) landed framework-side —
DocSchema, CLI collection/lint, kernel registration — and a showcase example shipped in #1793. But the developer docs site and the AI skills never mentioned thedocmetadata type. This closes that documentation gap.Changes
content/docs/guides/metadata/doc.mdx— authoring guide mirroring the other metadata-type guides: flatsrc/docs/*.md, namespace-prefixed naming, the platform-level/docs/<name>routing model, cross-references, Markdown support (anchors / highlight / GitHub alerts) and the MDX/image build bans.docin the metadata index table + sidebarmeta.json.src/docs/*.mdcorrectly (flat dir, namespace prefix, CommonMark+GFM, link-don't-embed for dynamic content), plusdescription/tagscoverage.Routing model documented (matches ADR-0046)
The viewer is platform-level: one global
/docs/<name>route, single-coordinate URL (no package/app prefix). App-level entry is opt-in — aurlnav item linking into that global URL. Per-app/per-package doc URLs are explicitly not the model (one doc → many URLs would break cross-references). A platform docs portal is a later additive concern.Scope
Docs + skill only — no package code. The frontend
/docs/<name>route +DocView+ nav entry in objectui remain the P2 follow-up (objectui does not yet consumedocmetadata).Changeset
Non-user-facing (docs/skill) —
skip-changeset.🤖 Generated with Claude Code