docs: rewrite AGENTS.md for consumers, reverse symlink direction (SD-2320)#2532
Conversation
SD-2320: AGENTS.md is now the canonical file at the repo root (was CLAUDE.md). CLAUDE.md symlinks to AGENTS.md so both Claude Code and other agent tools (Cursor, Copilot, Codex, Gemini CLI) read the same instructions. packages/superdoc/AGENTS.md is rewritten as a consumer-facing guide that ships with the npm package. Covers: install, embed (vanilla + React), configuration, theming, Document Engine (MCP, SDK, CLI), common tasks, and knowledge corrections for LLMs with stale training data.
💡 Codex Reviewsuperdoc/packages/superdoc/AGENTS.md Line 141 in a97689e  Replace the nonexistent content-changed event
This shipped AGENTS guide now tells consumers to subscribe with superdoc/packages/superdoc/AGENTS.md Line 140 in a97689e Rename the custom toolbar option to customButtons
The common-tasks table points consumers at superdoc/packages/superdoc/AGENTS.md Line 138 in a97689e Access comment commands through superdoc.activeEditor
This example uses ℹ️ About Codex in GitHubCodex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback". |
Reverse all AGENTS.md → CLAUDE.md symlinks across the monorepo. AGENTS.md is now the canonical file in every package/directory. CLAUDE.md symlinks to AGENTS.md so both Claude Code and other agent tools (Cursor, Copilot, Codex, Gemini CLI) read the same instructions. Locations updated: - apps/docs/, apps/cli/ - packages/layout-engine/, packages/react/, packages/super-editor/ - packages/super-editor/src/core/presentation-editor/ - tests/behavior/, tests/visual/ Only exception: packages/superdoc/ keeps both as standalone files (consumer-facing AGENTS.md vs internal contributor CLAUDE.md).
caio-pizzol
deleted the
caio/sd-2320-rewrite-agentsmd-for-consumers-agentsmd-spec
branch
|
🎉 This PR is included in superdoc v1.22.0-next.12 The release is available on GitHub release |
|
🎉 This PR is included in superdoc-cli v0.4.0-next.11 The release is available on GitHub release |
|
🎉 This PR is included in superdoc-sdk v1.1.0-next.11 |
|
🎉 This PR is included in superdoc v1.22.0 The release is available on GitHub release |
|
🎉 This PR is included in superdoc-sdk v1.1.0 |
|
🎉 This PR is included in @superdoc-dev/react v1.0.0-next.8 The release is available on GitHub release |
|
🎉 This PR is included in superdoc-cli v0.4.0 The release is available on GitHub release |
|
🎉 This PR is included in esign v2.2.0-next.3 The release is available on GitHub release |
|
🎉 This PR is included in template-builder v1.3.0-next.2 The release is available on GitHub release |
1 participant
AGENTS.md is now the canonical file at the repo root (was CLAUDE.md). CLAUDE.md symlinks to AGENTS.md so both Claude Code and other agent tools (Cursor, Copilot, Codex, Gemini CLI) read the same instructions.
packages/superdoc/AGENTS.md is rewritten as a consumer-facing guide that ships with the npm package. Covers: install, embed (vanilla + React), configuration, theming, Document Engine (MCP, SDK, CLI), common tasks, and knowledge corrections for LLMs with stale training data.