How to contribute documentation

    BFE’s documentation is mainly divided into the following categories:

    • Beginner’s Guide: to help users get started and inspired;

    • Developer Guides: to meet the needs of developers;

    Once the document is written, you can use the preview tool to check how the document appears to verify that your document is displayed correctly on the official website.

    Before doing this, please make sure your operating system has gitbook installed.

    Take the ubuntu system as an example, run:

    2. Clone related repository:

    First download the full repository:

    Then: open your browser and navigate to .

    All content should be written in Markdown (GitHub style).

    1. Contribute new documents

    • Create a new file or modify an existing article in the repository you are currently working on
    • Add the new document name to the corresponding index file (SUMMARY.md)
    • Run the preview tool in base directory of documents (docs/LANG)

    3. Preview modification

    Open your browser and navigate to .

    On the page to be updated, click Refresh Content at the top right corner.

    We encourage your contributions to all aspects of the platform and supportive contents. You can Fork or Clone repository, ask questions and feedback, or submit bugs on issues. For details, please refer to the Development Guide.