Skip to main content
This guide walks you through how to contribute to the YiDA Developer Center. There are two ways to contribute: Issues and Pull Requests.

​
Issues

We use GitHub Issues to track documentation problems in the Developer Center. If you find any issue in the documentation, submit an issue using the template below. We review submissions regularly and update the documentation accordingly:
Before reporting an issue, search existing issues first to avoid duplicates.

​
Pull Request

We recommend contributing through Pull Requests to help improve the YiDA Developer Center. Click the Edit this page button at the bottom of any document to get started. The steps are as follows:
  • Click Edit this page to open the GitHub page (sign up for a GitHub account if you do not have one).
  • Fork the Developer Center repository into your personal GitHub space (this is a one-time action; subsequent edits skip this step):
  • Go to the document editing page, make your changes, and commit them:
  • Confirm the changes and submit the Pull Request:
That completes a simple Pull Request submission. The YiDA team monitors all Pull Requests. We review and merge your changes, or we may ask you to revise them or explain why a change cannot be accepted. We release a patch version from the master branch every week.
You can also fork the Developer Center repository to your local environment, edit the documents locally, and submit a Pull Request. If you are new to submitting Pull Requests on GitHub, refer to the following article:How to Contribute Code on GitHub ElegantlyOur main branch is master, so submit Pull Requests to master.
When submitting new documentation content, briefly describe the background and use case in your Pull Request so that we can review and add it efficiently.

​
Local Development Workflow

The YiDA Developer Center is built with Docusaurus 2. After you clone the Developer Center repository and install the dependencies with npm install, you can run the following common commands:

​
Start Locally

Once started, access the site locally at http://localhost:3000/.
P.S.: Global search is not available in local development mode.

​
Build

The build output is written to the build directory.

​
Preview the Production Build Locally

Run this command only after npm run build completes. It starts a local static server based on the build directory, accessible at http://localhost:3000/. The behavior is identical to Production and supports global search.