Welcome

Welcome to the Documentation Site for Saho! This repository is intended to serve as a centralized location for all documentation related to our projects. You'll find everything you need to know about our projects here.

Table of Contents

TODO

For each project, create a section outlining:

  • Project Overview: Purpose, goals, and key stakeholders.
  • Tech Stack: List all technologies used, e.g., Django version, Python dependencies, database systems, WordPress plugins.
  • Setup Instructions: Step-by-step guide on setting up the project locally and in production.
  • Deployment Process: Detailed deployment process (e.g., using Ansible playbooks, Docker Compose files).

Overview

This documentation contains comprehensive info for our projects, including:

  • Overview: Detailed overviews of each project.
  • Project Guides: Step-by-step instructions for setting up development environments.
  • API Documentation: Detailed information about the APIs used in our projects.
  • Contribution Guides: Guidelines for contributing to the projects.

Getting Started

To get started with any of the projects, navigate to the respective project's folder and follow the instructions in the README.md file. This file will provide you with the necessary steps to set up the development environment and start contributing or using the project.

Contributing

We welcome contributions from the community! To contribute, please follow these steps:

  1. Fork the repository: Create a fork of this repository on GitHub.
  2. Clone your fork: Clone your forked repository to your local machine.
   git clone https://github.com/your-username/saho-docs.git
  1. Create a branch: Create a new branch for your changes.
git checkout -b feature/your-feature-name
  1. Make changes: Make your changes to the documentation.
  2. Commit changes: Commit your changes with a descriptive commit message.
git commit -m "Add feature: your-feature-name"
  1. Push to GitHub: Push your changes to your forked repository.
git push origin feature/your-feature-name
  1. Create a Pull Request: Create a pull request from your branch to the main repository.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.