|
1 |
| -# one-docs |
2 |
| -Docs for OneLead and OneInbox product |
| 1 | +# one-docs (One Suite Documentation) |
| 2 | + |
| 3 | +Welcome to the official documentation for One Suite, which includes the following products: |
| 4 | +- **OneLead** - A Frappe-based app for Meta and Google integration. [OneLead Repository](https://github.com/redsoftware-hq/onelead) |
| 5 | +- **OneInbox** - A unified inbox solution. [OneInbox Repository](https://github.com/redsoftware-hq/oneinbox) |
| 6 | +- **OneInbox_WhatsApp** - WhatsApp integration for seamless communication. [(Forked frappe_whatsapp)](https://github.com/shridarpatil/frappe_whatsapp) |
| 7 | + |
| 8 | +This repository contains the documentation for these products, built using **MkDocs** with the Material theme. The documentation is hosted on GitHub Pages. |
| 9 | + |
| 10 | +## Local Setup |
| 11 | + |
| 12 | +To run the documentation locally and make changes, follow these steps: |
| 13 | + |
| 14 | +### Prerequisites |
| 15 | +Ensure you have the following installed: |
| 16 | +- **Python (3.x)**: [Download here](https://www.python.org/downloads/) |
| 17 | +- **Git**: [Download here](https://git-scm.com/downloads) |
| 18 | + |
| 19 | + |
| 20 | +### Installation Steps |
| 21 | +1. **Clone the Repository** |
| 22 | + ```bash |
| 23 | + git clone https://github.com/YOUR_GITHUB_USERNAME/one-docs.git |
| 24 | + cd one-docs |
| 25 | + ``` |
| 26 | +2. **(Optional) Virtual Environment** |
| 27 | + ```bash |
| 28 | + python -m venv venv |
| 29 | + source venv/bin/activate # On Mac/Linux |
| 30 | + venv\Scripts\activate # On Windows |
| 31 | + ``` |
| 32 | + |
| 33 | +3. **Install Dependencies** |
| 34 | + ```bash |
| 35 | + pip install mkdocs-material |
| 36 | + ``` |
| 37 | + or |
| 38 | + ```bash |
| 39 | + pip install -r requirements.txt |
| 40 | + ``` |
| 41 | + |
| 42 | +4. **Run Locally** |
| 43 | + ```bash |
| 44 | + mkdocs serve |
| 45 | + ``` |
| 46 | + This will start a local server at: |
| 47 | + ```bash |
| 48 | + http://127.0.0.1:8000/ |
| 49 | + ``` |
| 50 | + Open this link in your browser to preview the documentation. |
| 51 | + |
| 52 | +5. **Stop the Server** |
| 53 | + To stop the local server, press **Ctrl + C** in the terminal. |
| 54 | + |
| 55 | +--- |
| 56 | + |
| 57 | +## Contribution Guide |
| 58 | + |
| 59 | +We welcome contributions to improve this documentation. Follow these guidelines to contribute: |
| 60 | + |
| 61 | +### 1. If You Make Changes in OneLead or OneInbox |
| 62 | +- If you **raise a Pull Request (PR) in OneLead or OneInbox**, please ensure that you **also update the relevant documentation in this repository**. |
| 63 | +- Attach the **OneLead/OneInbox PR** to the **documentation PR** for reference. |
| 64 | +- Ensure that the documentation clearly explains any new features, API changes, or installation steps. |
| 65 | + |
| 66 | +### 2. Make Your Changes |
| 67 | +- Edit Markdown files in the `docs/` directory. |
| 68 | +- Follow the existing structure when adding new documentation. |
| 69 | +- Use **clear and concise language**. |
| 70 | +- Include **code snippets, screenshots, or examples** where relevant. |
| 71 | +- Run `mkdocs serve` to preview your changes before submitting a PR. |
| 72 | + |
| 73 | +### 3. Follow Contribution Guidelines |
| 74 | +- Ensure documentation is **accurate and up to date**. |
| 75 | +- Use **proper formatting and Markdown syntax**. |
| 76 | +- Keep descriptions **clear and user-friendly**. |
| 77 | +- For API changes, **include request and response examples**. |
| 78 | +- If adding a new section, update `mkdocs.yml` for navigation. |
| 79 | + |
| 80 | + |
| 81 | +## Deployment (restricted to maintainers and auto-deploy on PR merge) |
| 82 | + |
| 83 | +To deploy updates to GitHub Pages, run: |
| 84 | +```bash |
| 85 | +mkdocs gh-deploy |
| 86 | +``` |
| 87 | +This will build and publish the documentation at: |
| 88 | +``` |
| 89 | +https://yourusername.github.io/one-docs/ |
| 90 | +``` |
| 91 | + |
| 92 | + |
| 93 | +## License |
| 94 | +This documentation is released under the **MIT License**. |
| 95 | + |
| 96 | +For any questions or feedback, feel free to open an issue in this repository. |
0 commit comments