Files
Discord.Net/docs/CONTRIBUTING.md
2016-08-29 15:34:46 -04:00

891 B

Contributing to Docs

I don't really have any strict conditions for writing documentation, but just keep these few guidelines in mind:

  • Keep code samples in the guides/samples folder
  • When referencing an object in the API, link to it's page in the API documentation.
  • Documentation should be written in clear and proper English*

* If anyone is interested in translating documentation into other languages, please open an issue or contact me on Discord (foxbot#0282).

Compiling

Documentation is compiled into a static site using DocFx. You must install a version of DocFx that supports .NET Core. The latest build of that is 2.1.0-cli-alpha.

After making changes, compile your changes into the static site with docfx. You can also view your changes live with docfx --serve.