docs/CONTRIBUTING.mdx
Fork and clone the repository
# Fork the repository (this will also clone it locally)
gh repo fork continuedev/continue
cd continue/docs
Install dependencies
npm install
Start the local development server
npm run dev
Your docs will be available at http://localhost:3000
Before creating any issues, we ask that you start with a GitHub Discussion. This helps us organize feedback and determine the best path forward.
Important: All issues should start as discussions. The Continue team will determine if and when a discussion should be escalated to a GitHub issue.
</Info>The Continue team will review discussions and may:
A discussion will typically be converted to an issue when:
We strongly encourage using Continue's AI assistance to maintain consistency and quality in our documentation. Here are three ways to set this up:
The easiest way to get started is using our pre-configured documentation agent:
<Steps> <Step title="Install the agent from Continue Mission Control"> Visit [the Docs Assistant - Mintlify in Mission Control](https://continue.dev/continuedev/docs-mintlify) and click "Install" to add it to your Continue setup. This agent comes pre-configured with all our documentation standards.<Info>
Learn more about Continue Configs in our [config documentation](/guides/understanding-configs).
</Info>
# Use the agent from the command line
cn "Create a new guide for using the Continue CLI with Linear" --config continuedev/docs-mintlify
```
</Tab>
<Tab title="IDE">
1. Open Continue in your IDE
2. Select the "Docs Assistant - Mintlify" agent from the model dropdown
3. Ask it to help you create or edit documentation
Example prompts:
- "Create a new guide for using the Continue CLI with Linear"
- "Update the getting-started guide with the new installation process"
- "Format this documentation according to Mintlify standards"
</Tab>
</Tabs>
If you want more control or customization, you can create your own documentation agent:
<Steps> <Step title="Create a new config"> Follow our [config creation guide](/mission-control/configs/create-a-config) to set up your own config. </Step> <Step title="Add the Continue Docs MCP"> Install from Continue Mission Control: https://continue.dev/continuedev/continue-docs-mcpThis MCP provides context about Continue's documentation structure and standards.
This rule ensures proper Mintlify component formatting.
# Use your agent from the command line
cn --config your-org/your-agent-name "Create a new guide for API authentication"
```
</Tab>
<Tab title="IDE">
1. Open Continue in your IDE
2. Select your custom agent from the model dropdown
3. Ask it to help you create or edit documentation
Example prompts:
- "Help me format this documentation according to Mintlify standards"
- "Create a troubleshooting section for this feature"
</Tab>
</Tabs>
When using Mintlify components, follow these formatting rules:
<Card title="Best Practice" icon="lightbulb">
Always include blank lines and proper indentation:
- Use 2-space indentation
- Add blank lines after opening tags
- Format lists as bullet points
</Card>
<Warning>
Important information should be formatted clearly:
- Each point on its own line
- Consistent indentation
- Clear, concise language
</Warning>
.mdx file in the guides directory---
title: "Your Guide Title"
description: "Brief description of what this guide covers"
---
docs.json to include your new page in the navigationUse language-specific code blocks:
```typescript
// Your TypeScript code here
const example = "Hello, Continue!";
```
npm run dev and check your changesnpm run build to ensure no build errorsCreate a feature branch
git checkout -b docs/your-feature-name
Commit your changes
git add .
git commit -m "docs: describe your changes"
Push and create a Pull Request
# Push to your fork and create a PR
git push origin docs/your-feature-name
gh pr create --web
The gh pr create command will automatically:
--webImportant: When your PR addresses a specific issue, make sure to link it using GitHub keywords.
</Info>To automatically link your PR to an issue and close it when the PR is merged, use one of these keywords in your PR description:
closes #issue_numberfixes #issue_numberresolves #issue_numberExample PR description:
Improved the installation guide with clearer steps for Windows users.
Closes #1234
This helps us track which issues are being worked on and automatically closes them when your PR is merged.
<Tip>Learn more about linking PRs to issues in the GitHub documentation.
</Tip>Thank you for contributing to Continue! Your efforts help make our documentation better for everyone. To learn more about contibuting to other parts of the project, check out our main CONTRIBUTING guide 🎉