DOCUMENTATION.md

Documentation

Welcome to our documentation guide. Here are some useful tips you need to know!

Table of Contents

• Documentation
• Table of Contents
  • General Talawa Documentation
  • Editing files

General Talawa Documentation

1. Our docs.talawa.io contains our Talawa documentation.
2. This repository contains the markdown files for the site.
3. The site and this repo use Docusaurus to render documentation markdown files into static HTML.

Editing files

The process in easy:

2. Follow the instructions in the INSTALLATION.md file to launch the repo's Docusaurus website on your machine.
3. Edit the appropriate markdown files in the docs/ directory
4. If adding a file, then you may need to edit the sidebars.js which is used to generate the left navigation menus. In most cases placing a new file in a directory is sufficient.
5. Edited files are viewable in the test Docusaurus website.
6. Always monitor the local website in your brower to make sure the changes are acceptable.
   • You'll be able to see errors that you can use for troubleshooting in the CLI window you used to launch the local website.