Before contributing, make sure you have .NET SDK installed, then open a terminal and enter the following command to install docfx:
dotnet tool update -g docfx
To build the website locally, run the following command:
docfx Nautilus/docfx.json --serve
The website will then be launched on http://localhost:8080 and you can preview it.
Simply make a PR to the master
branch with your changes. Please note the following:
- Make sure to add your documentation files (markdown) to the toc.yml appropriate for the type of document you're trying to add as well.
- Make sure to also add your documentation files to the
overview.md
appropriate intutorials/overview.md
orguides/overview.md
depending on type of your documentation.