[Docs] Rename docs_new/ to docs/ (#32123)
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 4.8
parent
c949e91f18
commit
b819d2fb5b
@@ -0,0 +1,34 @@
|
||||
> **Customize this file**: Tailor this template to your project by noting specific contribution types you're looking for, adding a Code of Conduct, or adjusting the writing guidelines to match your style.
|
||||
|
||||
# Contribute to the documentation
|
||||
|
||||
Thank you for your interest in contributing to our documentation! This guide will help you get started.
|
||||
|
||||
## How to contribute
|
||||
|
||||
### Option 1: Edit directly on GitHub
|
||||
|
||||
1. Navigate to the page you want to edit
|
||||
2. Click the "Edit this file" button (the pencil icon)
|
||||
3. Make your changes and submit a pull request
|
||||
|
||||
### Option 2: Local development
|
||||
|
||||
1. Fork and clone this repository
|
||||
2. Install the Mintlify CLI: `npm i -g mint`
|
||||
3. Create a branch for your changes
|
||||
4. Make changes
|
||||
5. Run `mint dev`
|
||||
6. Preview your changes at `http://localhost:3000`
|
||||
7. Commit your changes and submit a pull request
|
||||
|
||||
For more details on local development, see our [development guide](development.mdx).
|
||||
|
||||
## Writing guidelines
|
||||
|
||||
- **Use active voice**: "Run the command" not "The command should be run"
|
||||
- **Address the reader directly**: Use "you" instead of "the user"
|
||||
- **Keep sentences concise**: Aim for one idea per sentence
|
||||
- **Lead with the goal**: Start instructions with what the user wants to accomplish
|
||||
- **Use consistent terminology**: Don't alternate between synonyms for the same concept
|
||||
- **Include examples**: Show, don't just tell
|
||||
Reference in New Issue
Block a user