diff options
| author | GitHub Action <[email protected]> | 2025-12-05 21:42:15 +0000 |
|---|---|---|
| committer | GitHub Action <[email protected]> | 2025-12-05 21:42:15 +0000 |
| commit | cc35e6a0191c6f9c22c0573f1ea5f96775fc32bd (patch) | |
| tree | 2c4121941c2a979df56339677db815d4bf77036f /packages/docs/ai-tools | |
| parent | 328188816008fde10165597f432dac4c5d1016cd (diff) | |
| download | opencode-cc35e6a0191c6f9c22c0573f1ea5f96775fc32bd.tar.gz opencode-cc35e6a0191c6f9c22c0573f1ea5f96775fc32bd.zip | |
chore: format code
Diffstat (limited to 'packages/docs/ai-tools')
| -rw-r--r-- | packages/docs/ai-tools/claude-code.mdx | 15 | ||||
| -rw-r--r-- | packages/docs/ai-tools/cursor.mdx | 23 | ||||
| -rw-r--r-- | packages/docs/ai-tools/windsurf.mdx | 6 |
3 files changed, 27 insertions, 17 deletions
diff --git a/packages/docs/ai-tools/claude-code.mdx b/packages/docs/ai-tools/claude-code.mdx index bdc4e04b5..4039c6e0e 100644 --- a/packages/docs/ai-tools/claude-code.mdx +++ b/packages/docs/ai-tools/claude-code.mdx @@ -14,8 +14,8 @@ Claude Code is Anthropic's official CLI tool. This guide will help you set up Cl 1. Install Claude Code globally: - ```bash - npm install -g @anthropic-ai/claude-code +```bash +npm install -g @anthropic-ai/claude-code ``` 2. Navigate to your docs directory. @@ -26,20 +26,23 @@ Claude Code is Anthropic's official CLI tool. This guide will help you set up Cl Create a `CLAUDE.md` file at the root of your documentation repository to train Claude Code on your specific documentation standards: -````markdown +```markdown # 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 @@ -48,10 +51,12 @@ Create a `CLAUDE.md` file at the root of your documentation repository to train - 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 @@ -62,6 +67,7 @@ Create a `CLAUDE.md` file at the root of your documentation repository to train - 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 @@ -69,8 +75,9 @@ Create a `CLAUDE.md` file at the root of your documentation repository to train - 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 -```` +``` diff --git a/packages/docs/ai-tools/cursor.mdx b/packages/docs/ai-tools/cursor.mdx index fbb77616e..d05882919 100644 --- a/packages/docs/ai-tools/cursor.mdx +++ b/packages/docs/ai-tools/cursor.mdx @@ -99,12 +99,12 @@ Example of a single code block: ```javascript config.js const apiConfig = { - baseURL: 'https://api.example.com', + baseURL: "https://api.example.com", timeout: 5000, headers: { - 'Authorization': `Bearer ${process.env.API_TOKEN}` - } -}; + Authorization: `Bearer ${process.env.API_TOKEN}`, + }, +} ``` #### Code group with multiple languages @@ -120,7 +120,7 @@ const response = await fetch('/api/endpoint', { ```python Python import requests -response = requests.get('/api/endpoint', +response = requests.get('/api/endpoint', headers={'Authorization': f'Bearer {api_key}'}) ``` @@ -128,6 +128,7 @@ response = requests.get('/api/endpoint', curl -X GET '/api/endpoint' \ -H 'Authorization: Bearer YOUR_API_KEY' ``` + </CodeGroup> #### Request/response examples @@ -328,10 +329,11 @@ Wrap all images in frames: Use the HTML video element for self-hosted video content: <video - controls - className="w-full aspect-video rounded-xl" - src="link-to-your-video.com" -></video> +controls +className="w-full aspect-video rounded-xl" +src="link-to-your-video.com" + +> </video> Embed YouTube videos using iframe elements: @@ -362,9 +364,10 @@ Use updates for changelogs: - Improved error messages with actionable suggestions ## Bug fixes + - Fixed pagination issue with large datasets - Resolved authentication timeout problems -</Update> + </Update> ## Required page structure diff --git a/packages/docs/ai-tools/windsurf.mdx b/packages/docs/ai-tools/windsurf.mdx index fce12bfd1..310c81d5f 100644 --- a/packages/docs/ai-tools/windsurf.mdx +++ b/packages/docs/ai-tools/windsurf.mdx @@ -23,7 +23,7 @@ Create `.windsurf/rules.md` in your project root: ## Project context - This is a documentation project on the Mintlify platform -- We use MDX files with YAML frontmatter +- We use MDX files with YAML frontmatter - Navigation is configured in `docs.json` - We follow technical writing best practices @@ -53,7 +53,7 @@ description: "Concise description for SEO and navigation" - `<Note>` for helpful supplementary information - `<Warning>` for important cautions and breaking changes -- `<Tip>` for best practices and expert advice +- `<Tip>` for best practices and expert advice - `<Info>` for neutral contextual information - `<Check>` for success confirmations @@ -80,7 +80,7 @@ description: "Concise description for SEO and navigation" ## API documentation requirements -- Document all parameters with `<ParamField>` +- Document all parameters with `<ParamField>` - Show response structure with `<ResponseField>` - Include both success and error examples - Use `<Expandable>` for nested object properties |
