|
@@ -1,27 +1,21 @@ |
|
|
# Contributing to Docs |
|
|
# Contributing to Docs |
|
|
|
|
|
|
|
|
We don't really have any strict conditions for writing documentation, |
|
|
|
|
|
but just keep these few guidelines in mind: |
|
|
|
|
|
|
|
|
## General Guidelines |
|
|
|
|
|
|
|
|
|
|
|
We do not have any strict conditions for writing documentation, |
|
|
|
|
|
but keep these guidelines in mind: |
|
|
|
|
|
|
|
|
* Keep code samples in the `guides/samples` folder |
|
|
* Keep code samples in the `guides/samples` folder |
|
|
* When referencing an object in the API, link to it's page in the |
|
|
|
|
|
API documentation. |
|
|
|
|
|
|
|
|
* When referencing an object in the API, link to its page in the |
|
|
|
|
|
API documentation |
|
|
|
|
|
* Documentation should be written in an FAQ/Wiki-style format |
|
|
* Documentation should be written in clear and proper English* |
|
|
* Documentation should be written in clear and proper English* |
|
|
|
|
|
|
|
|
\* If anyone is interested in translating documentation into other |
|
|
\* If anyone is interested in translating documentation into other |
|
|
languages, please open an issue or contact me on |
|
|
languages, please open an issue or contact me on |
|
|
Discord (`foxbot#0282`). |
|
|
Discord (`foxbot#0282`). |
|
|
|
|
|
|
|
|
## Layout |
|
|
|
|
|
|
|
|
|
|
|
Documentation should be written in a FAQ/Wiki style format. |
|
|
|
|
|
|
|
|
|
|
|
Recommended reads: |
|
|
|
|
|
|
|
|
|
|
|
* http://docs.microsoft.com |
|
|
|
|
|
* http://flask.pocoo.org/docs/0.12/ |
|
|
|
|
|
|
|
|
|
|
|
Style consistencies: |
|
|
|
|
|
|
|
|
## Style Consistencies |
|
|
|
|
|
|
|
|
* Use a ruler set at 70 characters |
|
|
* Use a ruler set at 70 characters |
|
|
* Links should use long syntax |
|
|
* Links should use long syntax |
|
@@ -29,8 +23,13 @@ Style consistencies: |
|
|
|
|
|
|
|
|
Example of long link syntax: |
|
|
Example of long link syntax: |
|
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
|
```md |
|
|
Please consult the [API Documentation] for more information. |
|
|
Please consult the [API Documentation] for more information. |
|
|
|
|
|
|
|
|
[API Documentation]: xref:System.String |
|
|
[API Documentation]: xref:System.String |
|
|
``` |
|
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
## Recommended Reads |
|
|
|
|
|
|
|
|
|
|
|
* http://docs.microsoft.com |
|
|
|
|
|
* http://flask.pocoo.org/docs/0.12/ |