docs: adopt <Files> trees and AutoTypeTable config tables#187
Merged
Conversation
Two Fumadocs components that make the docs clearer and self-maintaining: <Files> file-tree diagrams replace plain text/code block trees: - quickstart: source vs committed-dist (.github/actio -> workflows) layout - configuration: config discovery walking up to the repo root - macros/templates: cross-file template library (lib.actio.yml) <AutoTypeTable> renders live prop tables straight from packages/core source, so they never drift from the types: - PermissionsConfig in macros/permissions (at-a-glance config summary) - PinConfig in supply-chain (per-class pinning controls) components/mdx.tsx registers File/Files/Folder; AutoTypeTable was already wired. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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
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.
Two Fumadocs components that make the docs clearer and self-maintaining. Final stack of the clarity overhaul, on top of #184/#185/#186.
<Files>— file-tree diagramsReplaces plain text/code-block trees with real rendered file trees (highlighted target node):
distlayout (.github/actio/→.github/workflows/)actio buildfrom anywhere" proseci.actio.yml+ sharedlib.actio.yml)<AutoTypeTable>— drift-free prop tablesRenders prop tables straight from
packages/core/src/config.ts, so they can never drift from the real types (JSDoc becomes the description column):PermissionsConfig→macros/permissions— at-a-glance config summary above the existing mode/mapping deep-divesPinConfig→supply-chain— per-class pinning controls (enabled/thirdParty/github/docker/allow/comment)ActioConfigwas already onconfigurationfrom #186; this extends the pattern to the two other config objects with rich JSDoc.Registration
components/mdx.tsx: registersFile/Files/Folder(additive).AutoTypeTablewas already wired (generator + FS cache).Gates — all green
npm run build→ exit 0 (core, so AutoTypeTable/twoslash types resolve)npm run docs:build→ exit 0, 164 doc pages SSG'dnpm test -- docs-completeness syntax-reference macros→ 84/84inferRunScopes;docker/enabled/thirdParty)🤖 Generated with Copilot CLI