Skip to content

Commit 67f332c

Browse files
authored
Create DOCUMENTATION.md
1 parent 458b836 commit 67f332c

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

DOCUMENTATION.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Documentation
2+
Welcome to our documentation guide. Here are some useful tips you need to know!
3+
## Where to find our documentation
4+
5+
Our documentation can be found in ONLY TWO PLACES:
6+
7+
1. ***Inline within the repository's code files***: We have automated processes to extract this information and place it in our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/).
8+
1. ***In our `talawa-docs` repository***: Our [Talawa-Docs](https://github.com/PalisadoesFoundation/talawa-docs) repository contains user edited markdown files that are automatically integrated into our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/) using the [Docusaurus](https://docusaurus.io/) package.
9+
10+
## How to use Docusaurus
11+
The process in easy:
12+
1. Install `talawa-docs` on your system
13+
1. Launch docusaurus on your system according to the `talawa-docs`documentation.
14+
- A local version of `docs.talawa.io` should automatically launched in your browser at http://localhost:3000/
15+
1. Add/modify the markdown documents to the `docs/` directory of the `talawa-docs` repository
16+
1. If adding a file, then you will also need to edit the `sidebars.js` which is used to generate the [docs.talawa.io](https://docs.talawa.io/) menus.
17+
1. Always monitor the local website in your brower to make sure the changes are acceptable.
18+
- You'll be able to see errors that you can use for troubleshooting in the CLI window you used to launch the local website.
19+
20+
## Other information
21+
***PLEASE*** do not add markdown files in this repository. Add them to `talawa-docs`!

0 commit comments

Comments
 (0)