docs: add AI-native onboarding group (docs for AI/agents, MCP setup, prompt library)#21842
Open
claude[bot] wants to merge 2 commits into
Open
docs: add AI-native onboarding group (docs for AI/agents, MCP setup, prompt library)#21842claude[bot] wants to merge 2 commits into
claude[bot] wants to merge 2 commits into
Conversation
…mpt library) Adds a small AI & Agents nav group beside the Quickstart group with three new pages: - ai/docs-for-agents: the site's machine-readable surfaces (llms.txt index, per-page .md access, contextual copy/open-in-assistant menu) - ai/mcp-setup: wiring the docs into an MCP-capable assistant via the markdown surfaces (no hosted MCP endpoint exists yet) - ai/prompt-library: nine curated, persona-named prompts mapped to the traced reader journeys, each grounded in in-site pages Option C (paved paths) slice 4. Tracks ethereum-optimism/solutions#958 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EBBBR8m2V8LjzMvuG7Go2L
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Sync with develop after #21841 (Contribute nav group, content guide) merged. Co-Authored-By: Claude
Contributor
Author
|
synced with develop after #21841 merged. |
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 / why
Option C (paved paths) Slice 4 — AI-native onboarding group (
ethereum-optimism/solutions,projects/docs-improver/plans/option-c-paved-paths.md). The docs platform already serves machine-readable surfaces (llms.txt index, per-page markdown, a contextual copy/open-in-assistant menu configured indocs.json) — nothing on the site tells readers or agents about them. This PR surfaces those affordances as a small Get-Started-adjacent nav group with three new pages.Before: an AI-assisted reader or agent has no on-site pointer to llms.txt or per-page markdown, no guidance for wiring the docs into an MCP-capable assistant, and no curated prompts — every assistant starts from scraped HTML and stale training data.
After: an "AI & Agents" group sits beside the Quickstart group with:
ai/docs-for-agents— the machine-readable surfaces: the llms.txt index,.md-suffix per-page access, the contextual copy/open-in-ChatGPT/open-in-Claude menu, and grounding tips (specs are normative; re-check version-sensitive values).ai/mcp-setup— how to wire the docs into an MCP-capable assistant. No hosted MCP endpoint exists for docs.optimism.io today, so the page documents the llms.txt/markdown route (works with or without MCP) plus a reference fetch-server config; the hosted-MCP request is filed separately as ethereum-optimism/solutions#959 per the plan's fallback.ai/prompt-library— nine curated prompts mapped to the traced reader journeys (batcher cost audit, deposit flow, challenger deployment, node-stack choice, node setup, L1 bridging, fee estimation, Supersim, stuck withdrawal). Every entry names its persona (2 chain operator, 2 node operator, 5 app developer) and links at least one in-site page; entries will cross-link solution guides as later slices ship them. Carrieslast-reviewed:frontmatter per the plan's curation contract.docs.json delta: one 8-line nav group, zero moves, zero redirects.
Verification (lite accuracy pass)
docs.json: verified in-repo —contextual.optionsis exactly["copy", "chatgpt", "claude"](docs.json lines 31–37 on this branch); the page describes exactly those three actions and no others..mdURLs inside prompt blocks) verified to exist as.mdxfiles in the repo by script; link text checked against each target's frontmattertitle..md): could not be completed from this session — needs one human browser check before merge. Attemptedhttps://docs.optimism.io/llms.txt,/node-operators/overview.md, and/chain-operators/guides/configuration/batcher.mdvia two independent fetch pipelines; every request to docs.optimism.io returns 403 to non-browser clients from this environment (the session's egress gateway policy-denies the host, and the site's bot protection 403s the web-fetch pipeline — the whole host including/behaves the same, so this is not a missing-page signal). Corroboration used instead: web search confirms the docs reference/llms.txtas the complete documentation index, and the merged Option C plan records that the platform serves llms.txt and per-page.mdnatively. Reviewer: please open https://docs.optimism.io/llms.txt and one.mdpage URL in a browser and confirm both render raw markdown.modelcontextprotocol/servers→src/fetch) and itsuvx mcp-server-fetchinvocation verified against the live repo README.docs.jsonparses as valid JSON after the edit.Reviewer checklist
https://docs.optimism.io/llms.txtand one per-page.mdURL render raw markdown (see verification note above)Tracking
Tracks ethereum-optimism/solutions#958
Part of the serialized docs.json lane; will be rebased as earlier lane PRs merge.
More context:
projects/docs-improver/README.mdinethereum-optimism/solutions.🤖 Drafted by the docs-improver agent — review before merge.
🤖 Generated with Claude Code
https://claude.ai/code/session_01EBBBR8m2V8LjzMvuG7Go2L
Generated by Claude Code