ADR-0046: Package documentation as metadata#1777
Merged
Merged
Conversation
Docs become a manifest element compiled from src/docs/ (pure Markdown, no MDX, no images in v1; meta.json subset for ordering). Derived content (field dictionaries, permission matrices, state machines) is rendered from metadata, never authored or generated. Repo layout separates four doc lifecycles (src / delivery / internal / CHANGELOG). Defines minimal docs set per package type, registry/console/AI-assistant rendering surfaces, i18n via locale-suffix files with AI-derived translations, and machine quality gates for AI authorship. Piloted on os-tianshun-mtc. 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
the
documentation
os-zhuang
added a commit
that referenced
this pull request
Jun 16, 2026
feat(chatbot): surface AI quota refusals as upgrade/top-up CTA (P1d) (#1777) objectui@6d4cc0971bfe4c3ffc65bd0c9a71d29a3ba1e31b
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
1 participant
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
New ADR establishing documentation as a first-class metadata element:
src/docs/compiles into the manifest like objects/views — docs ship with the package, registry grants apply automatically (zero registry change for v1, ridesmanifest_json)src/(ships) /delivery/(contract-bound, never ships) /internal/(engineering) / rootCHANGELOG.md(collected at publish)binds→ in-app AI assistant groundingos docs lint/os docs verify)Includes rejected-alternatives table (static sites, generated reference markdown, MDX, ordering schemes) and a five-phase rollout plan.
Piloted on
os-tianshun-mtc(steedos-labs): conventions validated there, including the empirical case for the derived-content rule (a generated 26-page dictionary was shipped and deleted within a day).🤖 Generated with Claude Code