Skip to content

Commit 637d6ce

Browse files
authored
modified url
1 parent bb1cf8f commit 637d6ce

File tree

1 file changed

+56
-56
lines changed

1 file changed

+56
-56
lines changed

README.md

+56-56
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,56 @@
1-
# myAGV Developer Guide
2-
3-
Welcome to the official documentation repository for the myAGV Developer Guide! Our aim is to provide a comprehensive and understandable guide to help developers program and control the myAGV using various programming languages and development environments.
4-
5-
## Getting Started
6-
7-
Before you begin, please make sure you are familiar with basic Git operations and Markdown syntax. This will help you contribute and retrieve information more efficiently.
8-
9-
## Document jump link
10-
11-
[SUMMARY_MYAGV_JN_2023_EN](https://docs.elephantrobotics.com/docs/myagv-jn-2023-en)
12-
13-
[SUMMARY_MYAGV_JN_2023_CN](https://docs.elephantrobotics.com/docs/myagv-jn-2023-cn)
14-
15-
[SUMMARY_MYAGV_PI_2023_EN](https://docs.elephantrobotics.com/docs/myagv-pi-2023-en)
16-
17-
[SUMMARY_MYAGV_PI_2023_CN](https://docs.elephantrobotics.com/docs/myagv-pi-2023-cn)
18-
19-
## How to Report Issues
20-
21-
If you encounter any problems while using the guide or developing with the myAGV, please follow these steps:
22-
23-
1. Visit the [Issues page](https://github.com/elephantrobotics/myAGV-docs/issues).
24-
2. Click the “New Issue” button to create a new issue.
25-
3. Provide as much detail as possible, including but not limited to:
26-
- Description of the issue
27-
- Steps to reproduce
28-
- Expected vs. actual results
29-
- Screenshots or code snippets, if possible.
30-
4. After submitting, please be patient for our team to respond.
31-
32-
## How to Submit Merge Requests
33-
34-
We warmly welcome and encourage community members to improve documentation or add new content. If you wish to contribute, please follow these steps:
35-
36-
1. Fork this repository to your GitHub account.
37-
2. Clone your forked repository to your local machine.
38-
3. Create a new branch for your changes.
39-
4. After making your changes, commit them to your fork.
40-
5. On GitHub, submit a merge request (MR) to the original repository’s `gitbook-en` branch.
41-
6. In your MR description, clearly describe the changes you've made and why.
42-
7. After submitting your MR, please be patient for our team to review it.
43-
44-
## Contribution Guidelines
45-
46-
We aim to maintain an open and welcoming environment, allowing everyone to contribute comfortably. Since we currently do not have a Code of Conduct, we ask you to simply be professional and respectful in your interactions within the project.
47-
48-
## Adding a Code of Conduct
49-
50-
We recommend adding a Code of Conduct to your project to foster a positive and inclusive environment. GitHub offers templates such as the Contributor Covenant, widely adopted across open-source projects. You can create a `CODE_OF_CONDUCT.md` in your repository and reference it here once added.
51-
52-
## Support and Contact
53-
54-
If you need any help, or have suggestions or feedback, please do not hesitate to contact us.
55-
56-
Thank you for your support and contributions!
1+
# myAGV Developer Guide
2+
3+
Welcome to the official documentation repository for the myAGV Developer Guide! Our aim is to provide a comprehensive and understandable guide to help developers program and control the myAGV using various programming languages and development environments.
4+
5+
## Getting Started
6+
7+
Before you begin, please make sure you are familiar with basic Git operations and Markdown syntax. This will help you contribute and retrieve information more efficiently.
8+
9+
## Document jump link
10+
11+
[SUMMARY_MYAGV_JN_2023_EN](https://docs.elephantrobotics.com/docs/myagv_jn23_en)
12+
13+
[SUMMARY_MYAGV_JN_2023_CN](https://docs.elephantrobotics.com/docs/myagv_jn23_cn)
14+
15+
[SUMMARY_MYAGV_PI_2023_EN](https://docs.elephantrobotics.com/docs/myagv_pi23_cn)
16+
17+
[SUMMARY_MYAGV_PI_2023_CN](https://docs.elephantrobotics.com/docs/myagv_pi23_cn)
18+
19+
## How to Report Issues
20+
21+
If you encounter any problems while using the guide or developing with the myAGV, please follow these steps:
22+
23+
1. Visit the [Issues page](https://github.com/elephantrobotics/myAGV-docs/issues).
24+
2. Click the “New Issue” button to create a new issue.
25+
3. Provide as much detail as possible, including but not limited to:
26+
- Description of the issue
27+
- Steps to reproduce
28+
- Expected vs. actual results
29+
- Screenshots or code snippets, if possible.
30+
4. After submitting, please be patient for our team to respond.
31+
32+
## How to Submit Merge Requests
33+
34+
We warmly welcome and encourage community members to improve documentation or add new content. If you wish to contribute, please follow these steps:
35+
36+
1. Fork this repository to your GitHub account.
37+
2. Clone your forked repository to your local machine.
38+
3. Create a new branch for your changes.
39+
4. After making your changes, commit them to your fork.
40+
5. On GitHub, submit a merge request (MR) to the original repository’s `gitbook-en` branch.
41+
6. In your MR description, clearly describe the changes you've made and why.
42+
7. After submitting your MR, please be patient for our team to review it.
43+
44+
## Contribution Guidelines
45+
46+
We aim to maintain an open and welcoming environment, allowing everyone to contribute comfortably. Since we currently do not have a Code of Conduct, we ask you to simply be professional and respectful in your interactions within the project.
47+
48+
## Adding a Code of Conduct
49+
50+
We recommend adding a Code of Conduct to your project to foster a positive and inclusive environment. GitHub offers templates such as the Contributor Covenant, widely adopted across open-source projects. You can create a `CODE_OF_CONDUCT.md` in your repository and reference it here once added.
51+
52+
## Support and Contact
53+
54+
If you need any help, or have suggestions or feedback, please do not hesitate to contact us.
55+
56+
Thank you for your support and contributions!

0 commit comments

Comments
 (0)