Browse Source

Added Documentation Section

Yoginth 7 years ago
parent
commit
ecf00d0095
1 changed files with 8 additions and 3 deletions
  1. 8 3
      README.md

+ 8 - 3
README.md

@@ -37,6 +37,7 @@ GoLang | PostgreSQL | Git
         - [Create a pull request](#create-a-pull-request)
         - [Create a pull request](#create-a-pull-request)
 - [Codebase](#codebase-)
 - [Codebase](#codebase-)
     - [The stack](#the-stack)
     - [The stack](#the-stack)
+- [Documentation](#documentation-)
 - [Features](#features-)
 - [Features](#features-)
 - [Core team](#core-team-)
 - [Core team](#core-team-)
 - [Sponsors](#sponsors-)
 - [Sponsors](#sponsors-)
@@ -66,17 +67,17 @@ When in doubt, ask a [core team member](#core-team)! You can mention us in any i
 
 
 ## Contribution guideline 📜
 ## Contribution guideline 📜
 
 
-#### Create an issue
+### Create an issue
 
 
 Nobody's perfect. Something doesn't work? Or could be done better? Let us know by creating an issue.
 Nobody's perfect. Something doesn't work? Or could be done better? Let us know by creating an issue.
 
 
 PS: a clear and detailed issue gets lots of love, all you have to do is follow the issue template!
 PS: a clear and detailed issue gets lots of love, all you have to do is follow the issue template!
 
 
-#### Clean code with tests
+### Clean code with tests
 
 
 Some existing code may be poorly written or untested, so we must have more scrutiny going forward. We test with **go test**, let us know if you have any questions about this!
 Some existing code may be poorly written or untested, so we must have more scrutiny going forward. We test with **go test**, let us know if you have any questions about this!
 
 
-#### Create a pull request
+### Create a pull request
 
 
 * Try to keep the pull requests small. A pull request should try its very best to address only a single concern.
 * Try to keep the pull requests small. A pull request should try its very best to address only a single concern.
 * Make sure all tests pass and add additional tests for the code you submit.
 * Make sure all tests pass and add additional tests for the code you submit.
@@ -90,6 +91,10 @@ Some existing code may be poorly written or untested, so we must have more scrut
 
 
 View **Gitote** tech stack [here](docs/STACK.md)
 View **Gitote** tech stack [here](docs/STACK.md)
 
 
+## Documentation 📑
+
+View **Gitote** documentations [here](docs)
+
 ## Features 🔮
 ## Features 🔮
 
 
 - Activity timeline
 - Activity timeline