Claude Code setup

bun install -g @anthropic-ai/claude-code

claude mcp add --transport http mint-tsdocs https://your-docs-url/mcp

You: Search my docs for how to customize templates
Claude: [Searches your MCP server and returns relevant results from your API reference]

# Mintlify documentation

## Working relationship
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
- ALWAYS ask for clarification rather than making assumptions
- NEVER lie, guess, or make up information

## Project context
- Format: MDX files with YAML frontmatter
- Config: docs.json for navigation, theme, settings
- Components: Mintlify components

## Content strategy
- Document just enough for user success - not too much, not too little
- Prioritize accuracy and usability of information
- Make content evergreen when possible
- Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason
- Check existing patterns for consistency
- Start by making the smallest reasonable changes

## Frontmatter requirements for pages
- title: Clear, descriptive page title
- description: Concise summary for SEO/navigation

## Writing standards
- Second-person voice ("you")
- Prerequisites at start of procedural content
- Test all code examples before publishing
- Match style and formatting of existing pages
- Include both basic and advanced use cases
- Language tags on all code blocks
- Alt text on all images
- Relative paths for internal links

## Git workflow
- NEVER use --no-verify when committing
- Ask how to handle uncommitted changes before starting
- Create a new branch when no clear branch exists for changes
- Commit frequently throughout development
- NEVER skip or disable pre-commit hooks

## Do not
- Skip frontmatter on any MDX file
- Use absolute URLs for internal links
- Include untested code examples
- Make assumptions - always ask for clarification

You: What parameters does the CacheManager constructor accept?
Claude: [Searches your API reference and explains CacheManagerOptions]

You: Show me all the template-related interfaces in my API
Claude: [Finds ITemplateData, ITemplateEngineOptions, etc. from your reference]

You: I need to link from my quickstart to the MarkdownDocumenter class reference
Claude: Use the relative path `/reference/mint-tsdocs.markdowndocumenter`

You: I'm adding a new guide. Can you check what frontmatter structure my existing guides use?
Claude: [Scans your docs and shows the pattern]

You: Find all code examples that import from 'mint-tsdocs' and update them to use the new import path
Claude: [Searches and helps update multiple pages]

You: What's the difference between ITemplateData and ITemplateEngineOptions?
You: Show me an example of customizing a template
You: How do I configure the navigation for generated API pages?

You: I'm getting a template error. Search my docs for template debugging
You: The API reference isn't generating. Check the config reference for common issues

You: I'm writing a guide about template customization. What should I link to in the API reference?
You: Check if there's already a guide about TypeInfo generation