Update template and guidance#95
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 4c2ae7b. Configure here.
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.

Integrates AI agent readiness features into the template so new sites start with these capabilities out of the box.
docusaurus-plugin-llmsdocusaurus-plugin-copy-page-button, positioned via a swizzledDocItem/Layoutcomponent (src/theme/DocItem/Layout/)scripts/copy-md-to-build.jspost-build script that copies source.mdfiles into thebuild output so agents can retrieve raw Markdown by appending
.mdto any doc URLstatic/robots.txtvercel.jsonheaders and rewrites.cursorrules and skillsAGENTS.mddocs/configure/agent-readiness.mdto explain what's pre-configured and walksthrough all required customization steps for a new site
Also makes other updates:
@docusaurus/theme-mermaid(since we use it in most new sites)docs/create/repo-structure.mdto document all new files and foldersNote
Medium Risk
Changes the production build and documents public AI crawling/content-signal defaults; impact is mostly template and docs, but adopters must customize URLs and licensing signals before go-live.
Overview
This PR turns the docs-template into an AI-ready starter: new sites get LLM discovery, raw Markdown access, and Cursor/agent guardrails by default.
Runtime and build:
docusaurus.config.jsregistersdocusaurus-plugin-llms(generates/llms.txtand/llms-full.txt) and enables Mermaid via@docusaurus/theme-mermaid. Thenpm run buildpipeline runsscripts/copy-md-to-build.jsafter Docusaurus so.mdURLs serve source Markdown with an agent pointer to/llms.txt. A swizzledsrc/theme/DocItem/Layoutadds the copy-page-as-Markdown control in the doc header.Contributor and agent UX: Adds
.cursor/rules/(Diataxis structure, voice, Markdown, terminology, workflow),.cursor/skills/(author-page,style-review), and rootAGENTS.md. Newdocs/configure/agent-readiness.mddocuments what ships pre-wired and required per-site customization (SITE_URL,robots.txtsitemap, terminology, etc.).GitHub and docs housekeeping: Issue forms (fix-content, new-content, site),
PULL_REQUEST_TEMPLATE.md, and expandeddocs/create/repo-structure.mdfor.cursor,AGENTS.md,scripts/, theme swizzles, andvercel.jsonagent headers/rewrites.docs/index.mdupdates the maintained-sites table (e.g. MetaMask maintainer wording; removes DIN and Phosphor rows).Reviewed by Cursor Bugbot for commit 446a820. Bugbot is set up for automated code reviews on this repo. Configure here.