From c15d460c51107e63551882c170e7df7b27bf31d3 Mon Sep 17 00:00:00 2001 From: Christopher F Date: Mon, 29 Aug 2016 15:34:46 -0400 Subject: [PATCH] contribution guide for docs --- docs/CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 docs/CONTRIBUTING.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 000000000..468ff7bd4 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# 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](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). + +After making changes, compile your changes into the static site with `docfx`. You can also view your changes live with `docfx --serve`. \ No newline at end of file