docs: publish content-type contracts for solution guide, learning unit, curriculum hub, and router/landing#21844
Open
claude[bot] wants to merge 3 commits into
Open
docs: publish content-type contracts for solution guide, learning unit, curriculum hub, and router/landing#21844claude[bot] wants to merge 3 commits into
claude[bot] wants to merge 3 commits into
Conversation
…it, curriculum hub, and router/landing Publishes the content-type contracts introduced by the Paved Paths plan (Option C, slice 2): a spec page per new type (purpose, tone, required components, title grammar, copy-paste template, exemplars) plus a maintainer-facing disambiguation decision table. The new types are declared as compositions of the existing diataxis: frontmatter taxonomy via an optional content-type: key, extending the landed sweep rather than forking it. Tracks ethereum-optimism/solutions#961 Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
5 tasks
Resolves docs.json conflict by folding this branch's five contribute pages into the Contribute group created by #21841, with content-guide listed first. Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
Author
|
synced with develop after #21841 merged; docs.json hunks folded into the merged Contribute group. |
Resolve docs.json Contribute group conflict: keep one group ordered content-guide, link-policy (from #21846), then this branch's five content-type pages. Co-Authored-By: Claude
Contributor
Author
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.
Requested by Matthew Cruz · Slack thread
What
Publishes the content-type contracts introduced by the Paved Paths plan (Option C, slice 2 —
projects/docs-improver/plans/option-c-paved-paths.mdin ethereum-optimism/solutions). Five new pages underdocs/public-docs/op-stack/contribute/:diataxis:frontmatter taxonomy.Before / After
solution-guide's template.Taxonomy: extension, not fork
diataxis:quadrant values from the landed 292-page sweep (docs: add diataxis tags across all sections #21830) are unchanged; the new types never appear asdiataxis:values.content-type:frontmatter key carried alongsidediataxis:(Cloudflare's published-content-type pattern). One sanctioned exception is documented: a pure router carriescontent-type: router-landingand nodiataxis:key (nothing on it to classify) — consistent with the sweep, which left the root router untagged.keywords.config.yamldelete-or-align decision (recorded here per the plan's risk item): the new types are not added to it — frontmatter is the only declaration surface. Recommend deletingkeywords.config.yamlas a separate follow-up; it is a dead second taxonomy.docs.json / merge order
docs.jsonhunk adds aContributegroup at the end of the OP Stack tab containing only these five pages. Synced with develop after docs: add canonical-home content guide and ThirdPartyContent component #21841 merged; the five pages now sit in the merged Contribute group (aftercontent-guide)./op-stack/contribute/content-guidenow resolve in-tree (that page shipped in docs: add canonical-home content guide and ThirdPartyContent component #21841).Checks run
docs.jsonparses; all five nav entries map to existing files.develop(scripted check), including the content-guide links (shipped in docs: add canonical-home content guide and ThirdPartyContent component #21841).Follow-ups (out of scope here)
keywords.config.yamldeletion (decision recorded above).Reviewer checklist
content-type:contract reads as an extension of thediataxis:sweep, not a fork## Templateblock works as a copy-paste scaffoldTracks ethereum-optimism/solutions#961
Part of the docs-improver program — see
projects/docs-improver/README.mdin ethereum-optimism/solutions. Skill-template mirror PR in ethereum-optimism/solutions accompanies this one.🤖 Drafted by the docs-improver agent — review before merge.
🤖 Generated with Claude Code
https://claude.ai/code/session_01EBBBR8m2V8LjzMvuG7Go2L
Generated by Claude Code