mirror of
https://gitlab.com/KenanZhu/AutoLibraryManuals.git
synced 2026-11-05 05:35:51 +08:00
34 lines
1.7 KiB
Markdown
34 lines
1.7 KiB
Markdown
> **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
|
|
|
|
### Edit directly on GitLab
|
|
|
|
1. Open the file you want to edit in the [AutoLibrary Manuals repository](https://gitlab.com/KenanZhu/AutoLibraryManuals). If you don't have write access, fork the repository and open the file in your fork.
|
|
2. Select **Edit** > **Edit single file** and make your changes.
|
|
3. Commit your changes to a new branch and open a merge request targeting the manuals repository.
|
|
|
|
### Develop locally
|
|
|
|
1. Fork and clone the [AutoLibrary Manuals repository](https://gitlab.com/KenanZhu/AutoLibraryManuals).
|
|
2. Run `npm i -g mint` to install the Mintlify CLI.
|
|
3. Create a branch and edit the documentation.
|
|
4. Run `mint dev` from the directory containing `docs.json`.
|
|
5. Preview your changes at `http://localhost:3000`.
|
|
6. Commit and push your branch, then open a merge request targeting the manuals repository.
|
|
|
|
For more details, see the [local development instructions](README.md#开发).
|
|
|
|
## 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
|