Skip to content

docs: LLM-first quickstart with agent setup and MCP - #2534

Merged
caio-pizzol merged 4 commits into
mainfrom
caio/sd-2244-homepage-cta-add-llm-first-quick-start-instructions
Mar 23, 2026
Merged

docs: LLM-first quickstart with agent setup and MCP#2534
caio-pizzol merged 4 commits into
mainfrom
caio/sd-2244-homepage-cta-add-llm-first-quick-start-instructions

Conversation

@caio-pizzol

@caio-pizzol caio-pizzol commented Mar 23, 2026

Copy link
Copy Markdown
Contributor

Summary

Quickstart page leads with agent-first instructions:

  1. npx @superdoc-dev/create β€” set up project for AI agents
  2. MCP server β€” connect agent to DOCX files
  3. Backend SDK/CLI β€” Node.js, Python, CLI tabs
  4. Embed editor β€” existing content preserved

Depends on #2533.

Test plan

  • Preview with npx mintlify dev --port 3005
  • Python snippet uses sync client with dict params
  • All card icons render
  • All doc links resolve

SD-2244: Restructure the quickstart page to lead with agent-first
instructions:

1. superdoc init β€” generates AGENTS.md for AI coding agents
2. MCP server setup β€” one command for Claude Code, config for
   Cursor/Windsurf
3. Backend code β€” SDK (Node.js, Python) and CLI tabs
4. Embed editor β€” existing content preserved below

The page now serves three audiences: developers using AI coding
agents, backend automation developers, and web app developers
embedding the visual editor.
@linear

linear Bot commented Mar 23, 2026

Copy link
Copy Markdown

@mintlify

mintlify Bot commented Mar 23, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
SuperDoc 🟒 Ready View Preview Mar 23, 2026, 8:44 PM

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸ’‘ Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 482c215ff2

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

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".

Comment thread apps/docs/getting-started/quickstart.mdx Outdated
Comment thread apps/docs/getting-started/quickstart.mdx Outdated
Comment thread apps/docs/getting-started/quickstart.mdx Outdated
- Replace missing icons (gear β†’ screwdriver-wrench, github β†’ arrow-up-right-from-square)
- Fix Python SDK example: sync client uses dict params and no await
@caio-pizzol caio-pizzol changed the title docs: LLM-first quickstart with superdoc init and MCP setup (SD-2244) docs: LLM-first quickstart with agent setup and MCP Mar 23, 2026
@caio-pizzol
caio-pizzol merged commit e5271c7 into main Mar 23, 2026
4 checks passed
@caio-pizzol
caio-pizzol deleted the caio/sd-2244-homepage-cta-add-llm-first-quick-start-instructions branch March 23, 2026 23:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant