Rename ai-agents docs section to agents#1621
Open
youssefea wants to merge 8 commits into
Open
Conversation
Rename the docs/ai-agents directory to docs/agents and update all internal references, navigation, and section indexes accordingly. - Move docs/ai-agents/ -> docs/agents/ (git rename, history preserved) - Update nav pages in docs.json to the new agents/ paths - Point all redirect destinations at /agents and add catch-all redirects (/ai-agents and /ai-agents/:slug*) so legacy links keep working; existing legacy /ai-agents sources are preserved - Add Skills and Support anchors to the Agents tab, matching the pattern used by other sections (e.g. Account's GitHub/Support links) - Regenerate agents.md and llms.txt / llms-full.txt indexes Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
Collaborator
🟡 Heimdall Review Status
|
The generated docs/agents.md already serves at /agents, which clashed with the section's index.mdx (also /agents). Move the Base MCP overview to its own route and let agents.md own /agents. - Rename docs/agents/index.mdx -> docs/agents/base-mcp.mdx (/agents/base-mcp) - Point nav, redirect destinations, and content links at /agents/base-mcp - Redirect /ai-agents and /ai-agents/index to /agents/base-mcp - Regenerate agents.md and llms.txt / llms-full.txt indexes Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
…e-mcp" This reverts commit d79c559.
Add docs/agents.md to .mintignore so it is not built into a page and does not claim the /agents route — resolving the clash with the section's index.mdx while keeping /agents as the Base MCP overview. agents.md is a repo artifact (the AI-agent docs index), not a site page; the public index is /llms.txt. This mirrors the existing writing.md exclusion. The earlier base-mcp rename is reverted. Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Try the standard uppercase AGENTS.md filename instead of excluding the index from the build. Whether this avoids the /agents route clash with the section's index.mdx will be confirmed by the preview build. - Rename docs/agents.md -> docs/AGENTS.md - Remove agents.md from docs/.mintignore (no longer build-excluded) - Add AGENTS.md to docs-utils skipFiles so the generator still excludes its own output from the index (previously relied on .mintignore; fixes a latent self-reference where the index listed "agents") - Point the generator, git hooks, hook config/lib, and docs at AGENTS.md (the "agents.md" commit-message trigger token is matched case-insensitively, so it is left unchanged) Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
…-agents # Conflicts: # docs/AGENTS.md # docs/llms-full.txt # docs/llms.txt
Add a Note callout on the agents overview directing AI agents to the machine-readable docs index at https://docs.base.org/AGENTS.md, emphasizing the uppercase filename. Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
Replace the Note callout with <Visibility for="agents">, which hides the pointer from the human web UI while including it in the Markdown (.md) output that agents fetch — the intended audience for the canonical uppercase AGENTS.md index. Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.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
2 participants
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.
Summary
Renames the documentation section from ai-agents to agents, redirects all legacy
/ai-agentslinks to the new/agentspaths, and adds section anchor links (Skills + Support) to the Agents tab — matching the pattern used by other sections (e.g. Account's GitHub/Support links).Changes
docs/ai-agents/→docs/agents/(tracked as a git rename, so history is preserved).docs.json): all Agents tab pages now point atagents/....docs.json):/agents./ai-agents/...sources are kept so old deep links still resolve./ai-agents → /agentsand/ai-agents/:slug* → /agents/:slug*, placed last so the specific legacy redirects keep priority.global.anchorsblock to the Agents tab with Skills (github.com/base/skills) and Support (Discord) links./ai-agentslinks across the moved files andget-started/(theresources-for-ai-agentspage name is intentionally untouched).agents.md,llms.txt,llms-full.txt.Verification
docs.jsonvalidates as JSON./agentsinternal links (remaining lint findings are pre-existing code-block/image warnings unrelated to this rename).ai-agentsreferences remain outside the intentionalresources-for-ai-agentspage and unrelated legacy redirect sources.Generated with Claude Code