From 3ea5befc9e1cb025b2eb14ba84c3eda729f21661 Mon Sep 17 00:00:00 2001 From: Still Hsu <341464@gmail.com> Date: Sun, 17 Jun 2018 18:45:33 +0800 Subject: [PATCH] Cleanup README & Contribution guide --- docs/CONTRIBUTING.md | 31 +++++++++++++++---------------- docs/README.md | 4 ++-- 2 files changed, 17 insertions(+), 18 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 3c4ebac71..8641d377e 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,27 +1,21 @@ # 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 -* 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* \* If anyone is interested in translating documentation into other languages, please open an issue or contact me on 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 * Links should use long syntax @@ -29,8 +23,13 @@ Style consistencies: Example of long link syntax: -``` +```md Please consult the [API Documentation] for more information. [API Documentation]: xref:System.String -``` \ No newline at end of file +``` + +## Recommended Reads + +* http://docs.microsoft.com +* http://flask.pocoo.org/docs/0.12/ \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 6aa4430e3..4a06dccab 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,8 +8,8 @@ Instructions for installing this tool can be found [here][docfx-installing]. parameter to preview the site locally. Some elements of the page may appear incorrectly when hosted offline. -Please note that if you intend to target a specific version, ensure that -you have the correct version checked out. +Please note that if you intend to target a specific version, ensure +that you have the correct version checked out. [docfx-main]: https://dotnet.github.io/docfx/ [docfx-installing]: https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html \ No newline at end of file