docs: make syntax.mdx the single source of truth for macros (S2: reference hub)#180
Merged
Conversation
Reference-hub de-duplication (Session 2 of the docs overhaul):
- syntax.mdx: tighten intro to canonical positioning (superset +
compile-time macros, zero runtime/lock-in) and state it is the
canonical keyword dictionary while /docs/macros/* are the deep dives.
Replace the single quick-ref table with scannable tables grouped by
scope (Workflow/Job/Step/Lifecycle); flag `fragments` deprecated.
No `{/* macro:X */}` markers or `<TypeTable>`s changed (schema-locked).
- glossary.mdx: stop re-enumerating macros. Delete the stale 9-entry
"Macro keywords" section and trim the inline list in the Macro term,
both now pointing to /docs/syntax + /docs/macros. Add Executor and
Hoist concept defs; drop "fragment" from the frontmatter description.
- AGENTS.md: replace the stale 11-row macro table with the reconciled
~19-keyword taxonomy grouped by job, plus a pointer to the syntax
reference for advanced keys. Example block (already _anchors/params/
retry-led) kept.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…ages S3 (PR #183) landed /docs/macros/anchors and /docs/macros/templates. - templates section: "Full guide" now points at /docs/macros/templates instead of the deprecated /docs/macros/fragments. - _anchors section: add a "Full guide" link to /docs/macros/anchors (it previously had none). The deprecated `fragments` section and the shared `inject` call-site keep their /docs/macros/fragments link. No `{/* macro:X */}` markers or `<TypeTable>`s changed. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
… page The shared `inject` step section pointed its "Full guide" at the deprecated /docs/macros/fragments page. inject's live home is the templates mechanism (inject … with, cross-file inject: ./lib#name), so point users there instead. 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
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.
Session 2 — Reference hub & de-duplication
Part of the 4-session docs overhaul. Fixes maintainer complaint #2: the macro reference was duplicated and inconsistent across pages. This makes
/docs/syntaxthe single source of truth for the keyword dictionary and stops hand-maintaining macro lists elsewhere.Changes
docs/content/docs/syntax.mdx(the SSOT)actio buildexpands them, zero runtime / zero lock-in, macro-free file already works. States this page is the canonical keyword dictionary and/docs/macros/*are the deep dives.fragmentsrow flagged deprecated.{/* macro:X */}markers and 11<TypeTable>s untouched (schema-locked, machine-enforced).docs/content/docs/glossary.mdx## Macro keywordssection and trimmed the inline keyword list in the Macro term → both now point to/docs/syntax+/docs/macros.AGENTS.mdlet,coercion,finally, hoist overrides). Example block (already_anchors/params/retry-led) kept.Verification
docs-completeness3/3 ✓syntax-reference15/15 ✓ (35 markers + 11 TypeTables intact)macros66/66 ✓npm run docs:build✓ (all 154 pages prerendered)