docs: improve agent discoverability (README, AGENTS.md, llms.txt)#2588
docs: improve agent discoverability (README, AGENTS.md, llms.txt)#2588PeterHollens wants to merge 1 commit intosuperdoc-dev:mainfrom
Conversation
…s.txt Sharpen SuperDoc's positioning for AI agents evaluating DOCX editing tools. - README: rewrite tagline, add best-for/not-for filter, start-here routing table, expanded agent section with integration paths and use cases - AGENTS.md (package): restructure for agent evaluation — positioning, best-for/not-for, all integration paths, capability overview, knowledge corrections - llms.txt: new concise context file for AI crawlers with positioning, quick start, and links - llms-full.txt: comprehensive context with architecture, code examples, full operation list, and knowledge corrections Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
caio-pizzol
left a comment
There was a problem hiding this comment.
@PeterHollens appreciate the effort here — adding llms.txt / llms-full.txt is something we've been wanting to do (SD-2319). a few things to address before merging.
headline: we're keeping "Modern document editing and tooling" for now. AI agents are a big focus for us but the headline needs to cover all SuperDoc use cases, not just agent workflows.
AGENTS.md: the current version has working code examples, a config table, and a "common tasks" cheat sheet — exactly what an AI agent needs when it finds this file in node_modules/. this rewrite replaces all of that with marketing-style content. i'd keep the current file as-is.
llms.txt files: great addition. the content needs a tone pass though — check brand.md for our voice guidelines. some of it reads more like a landing page than a technical reference. a couple factual fixes needed too (inline comments).
README.md: the "Best for / Not for" lists and new sections shift the tone from developer docs to product marketing. our brand leans toward "show, don't sell" — the current README structure works better.
suggested path: keep the llms files (with fixes + tone pass), drop the AGENTS.md and README changes, and use brand.md as the style guide.
| @@ -17,9 +17,9 @@ | |||
| </div> | |||
|
|
|||
| <p align="center"> | |||
There was a problem hiding this comment.
we're keeping "Modern document editing and tooling" for now. AI agents are a big focus for us but the headline needs to cover all SuperDoc use cases, not just agent workflows.
| @@ -28,7 +28,45 @@ | |||
| </a> | |||
There was a problem hiding this comment.
the "Best for / Not for" lists shift the README from developer docs toward product marketing. our brand leans toward "show, don't sell" — the current structure (quick start first, features second) fits better.
| @@ -1,98 +1,37 @@ | |||
| # SuperDoc | |||
There was a problem hiding this comment.
the current AGENTS.md has code examples, a config table, and a common tasks cheat sheet — that's what agents actually need when they find this in node_modules/. this rewrite replaces all of it with positioning content. i'd keep the current version.
| ## Links | ||
|
|
||
| - Docs: https://docs.superdoc.dev | ||
| - AI agents guide: https://docs.superdoc.dev/document-engine/ai-agents/llm-tools |
There was a problem hiding this comment.
lines 46 and 48 point to the same URL. one should be removed or point somewhere different.
| @@ -0,0 +1,279 @@ | |||
| # SuperDoc — Full Context for LLMs | |||
There was a problem hiding this comment.
"360+ operations" — actual count is 344. should say "340+". same in llms.txt and AGENTS.md.
Summary
Sharpens SuperDoc's positioning for AI agents evaluating DOCX editing tools. Four low-risk, additive changes:
Context
AI agents increasingly discover and evaluate tools by reading READMEs,
llms.txt, andAGENTS.mdfiles. These changes make it easier for an agent to conclude "SuperDoc is the right tool for real DOCX workflows" without reading multiple doc pages.Based on competitive analysis of Nutrient, CKEditor, Syncfusion, Apryse, OnlyOffice, and Microsoft Word MCP — SuperDoc has the strongest combination of OOXML-native editing, tracked changes, agent tooling, and self-hosted deployment. The gap is discoverability, not capability.
Test plan
AGENTS.mdcontent is accurate against current MCP/SDK capabilities🤖 Generated with Claude Code