You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

CONTRIBUTING.md 891 B

123456789101112131415
  1. # Contributing to Docs
  2. I don't really have any strict conditions for writing documentation, but just keep these few guidelines in mind:
  3. * Keep code samples in the `guides/samples` folder
  4. * When referencing an object in the API, link to it's page in the API documentation.
  5. * Documentation should be written in clear and proper English*
  6. \* If anyone is interested in translating documentation into other languages, please open an issue or contact me on Discord (`foxbot#0282`).
  7. ### Compiling
  8. Documentation is compiled into a static site using [DocFx](dotnet.github.io/docfx/). You **must** install a version of DocFx that supports .NET Core. The latest build of that is [2.1.0-cli-alpha](https://github.com/dotnet/docfx/releases/tag/v2.1.0-cli-alpha).
  9. After making changes, compile your changes into the static site with `docfx`. You can also view your changes live with `docfx --serve`.