myAGV Developer Guide

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.

Getting Started

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.

Document jump link

SUMMARY_MYAGV_JN_2023_EN

SUMMARY_MYAGV_JN_2023_CN

SUMMARY_MYAGV_PI_2023_EN

SUMMARY_MYAGV_PI_2023_CN

How to Report Issues

If you encounter any problems while using the guide or developing with the myAGV, please follow these steps:

1. Visit the Issues page.
2. Click the “New Issue” button to create a new issue.
3. Provide as much detail as possible, including but not limited to:
   • Description of the issue
   • Steps to reproduce
   • Expected vs. actual results
   • Screenshots or code snippets, if possible.
4. After submitting, please be patient for our team to respond.

How to Submit Merge Requests

We warmly welcome and encourage community members to improve documentation or add new content. If you wish to contribute, please follow these steps:

1. Fork this repository to your GitHub account.
2. Clone your forked repository to your local machine.
3. Create a new branch for your changes.
4. After making your changes, commit them to your fork.
5. On GitHub, submit a merge request (MR) to the original repository’s gitbook-en branch.
6. In your MR description, clearly describe the changes you've made and why.
7. After submitting your MR, please be patient for our team to review it.

Contribution Guidelines

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.

Adding a Code of Conduct

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.

Support and Contact

If you need any help, or have suggestions or feedback, please do not hesitate to contact us.

Thank you for your support and contributions!