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 1.2 kB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. # Contributing to Docs
  2. I don't really have any strict conditions for writing documentation,
  3. but just keep these few guidelines in mind:
  4. * Keep code samples in the `guides/samples` folder
  5. * When referencing an object in the API, link to it's page in the
  6. API documentation.
  7. * Documentation should be written in clear and proper English*
  8. \* If anyone is interested in translating documentation into other
  9. languages, please open an issue or contact me on
  10. Discord (`foxbot#0282`).
  11. ### Layout
  12. Documentation should be written in a FAQ/Wiki style format.
  13. Recommended reads:
  14. * http://docs.microsoft.com
  15. * http://flask.pocoo.org/docs/0.12/
  16. Style consistencies:
  17. * Use a ruler set at 70 characters
  18. * Links should use long syntax
  19. * Pages should be short and concise, not broad and long
  20. Example of long link syntax:
  21. ```
  22. Please consult the [API Documentation] for more information.
  23. [API Documentation]: xref:System.String
  24. ```
  25. ### Compiling
  26. Documentation is compiled into a static site using [DocFx].
  27. We currently use the most recent build off the dev branch.
  28. After making changes, compile your changes into the static site with
  29. `docfx`. You can also view your changes live with `docfx --serve`.
  30. [DocFx]: https://dotnet.github.io/docfx/