mirror of
https://gitlab.com/KenanZhu/AutoLibraryManuals.git
synced 2026-11-05 05:35:51 +08:00
docs: update repository links for Gitea and GitLab
This commit is contained in:
1 parent
3a3aa57ad6
commit
b3ce024a91
7 files changed
+77
-100
No files matched your search
+12
-13
@@ -6,23 +6,22 @@ Thank you for your interest in contributing to our documentation! This guide wil
|
||||
|
||||
## How to contribute
|
||||
|
||||
### Option 1: Edit directly on GitHub
|
||||
### Edit directly on GitLab
|
||||
|
||||
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
|
||||
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.
|
||||
|
||||
### Option 2: Local development
|
||||
### Develop locally
|
||||
|
||||
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. Navigate to the docs directory and run `mint dev`
|
||||
6. Preview your changes at `http://localhost:3000`
|
||||
7. Commit your changes and submit a pull request
|
||||
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 on local development, see our [development guide](development.mdx).
|
||||
For more details, see the [local development instructions](README.md#开发).
|
||||
|
||||
## Writing guidelines
|
||||
|
||||
|
||||
Reference in new issue
Block a user