Writing Docs

The Ent documentation website is generated from the project’s main GitHub repo.

Follow this short guide to contribute documentation improvements and additions:

1. the main repository.

3. Install the dependencies:

4. Run the website in development mode:

5. Open you browser at .

• Ent uses Golang CommitMessage formats to keep the repository’s history nice and readable. As such, please use a commit message such as:

2. The file should be formatted as such:

Where id should be a unique identifier for the document, should be the same as the filename without the suffix, and title is the title of the document as it will appear in the page itself and any navigation element on the site.

3. If you want the page to appear in the documentation website’s sidebar, add its to website/sidebars.js, for example: