Since the open source of PaddlePaddle, we have provided high-quality Chinese and English documents. There are also many developers who have made important contributions to the improvement of the quality of the documentation. Thanks very much for every developer's support for PaddlePaddle documentation.
We very much welcome you to participate in the construction of PaddlePaddle documentation and work with us to improve the quality of PaddlePaddle documentation. At present, PaddlePaddle document is divided into the following parts, you can choose any part of your interest to participate:
- Guides
- Practice
- API Documentation
This part of the content is mainly a guide to the use of PaddlePaddle. You can correct or improve the existing content, or you can add documents that you think are important. We very much welcome your suggestions and modifications regarding the use of the guides document.
The Practice is mainly to use PaddlePaddle for specific case implementation. At present, many developers have contributed very good cases, such as OCR recognition, face key-point detection, etc. We welcome you to submit your project to our repo, and finally show it on the official website of PaddlePaddle.
PaddlePaddle's API documentation contains an introduction to the API. We welcome you to propose changes to API documentation, whether it is typo or modification instructions and examples, we are very grateful for any contributions you have made to the API documentation.
This part of the content is stored in the docs/docs/guides directory, you can make your changes by submitting a PR. For more information, please refer to: Document Contribution Guide.
This part of the content is divided into two parts, the source code and the official website documentation. The source code is stored in the form of a notebook in book/paddle2.0_docs directory; after your notebook file is merged, we will convert it into an md file and store it in [docs/docs/tutorial](https: //github.com/PaddlePaddle/docs/tree/develop/docs/tutorial), and then presented to the official website. For more information, please refer to: [Call for Contribution] Tutorials for PaddlePaddle 2.0.
PaddlePaddle provides API documentation in both Chinese and English. The English API documentation is stored in the Paddle, you can modify English documents at this location; and Chinese API documents are stored in the docs/docs/api. You can fix and improve any errors and content in the document, or add content that you think is needed in the document. We are very grateful for all your contributions to the API document. For more information, please refer to: English API Documentation Contribution Guide, Chinese API Documentation Contribution Guide.
Any modification of PaddlePaddle documentation should be completed by submitting a PR. For more information, please refer to Submit PR.