Skip to content

Commit 22f21a5

Browse files
init: initial setup for one suit documents
1 parent 05ebd2f commit 22f21a5

File tree

16 files changed

+184
-2
lines changed

16 files changed

+184
-2
lines changed

.github/workflows/deploy.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Deploy MkDocs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout repository
13+
uses: actions/checkout@v3
14+
15+
- name: Set up Python
16+
uses: actions/setup-python@v3
17+
with:
18+
python-version: '3.x'
19+
20+
- name: Install dependencies
21+
run: pip install -r requirements.txt
22+
23+
- name: Deploy MkDocs
24+
run: mkdocs gh-deploy

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
venv

README.md

Lines changed: 96 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,96 @@
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.

docs/index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# OneLead - Lead Management Solution
2+
3+
OneLead is a **Frappe-based lead management system** designed to seamlessly integrate with multiple lead sources, including **Meta (Facebook) Leads** and **Google Leads**. It automates lead collection, processing, and assignment within your business workflow.
4+
5+
## Lead Sources
6+
7+
### 🔹 Meta Leads
8+
OneLead integrates with **Meta (Facebook) Lead Ads**, allowing businesses to **automatically capture** leads from Facebook and Instagram ad campaigns, map them to internal CRM systems, and assign them to sales teams.
9+
10+
### 🔹 Google Leads
11+
With OneLead's **Google Lead Integration**, you can fetch leads directly from **Google Ads Lead Form Extensions**, ensuring that every inquiry is instantly available in your CRM for follow-up.
12+
13+
## Features
14+
- 🔄 **Automated lead fetching** from Meta & Google.
15+
- 📌 **Custom mapping** to internal lead structures.
16+
- 📊 **Lead tracking & assignment** based on business rules.
17+
- 🔗 **Webhook-based integration** for real-time updates.
18+
19+
Proceed to **Meta Integration** for detailed setup instructions.

docs/oneinbox/index.md

Whitespace-only changes.

docs/oneinbox/instagram/index.md

Whitespace-only changes.

docs/oneinbox/messenger/index.md

Whitespace-only changes.

docs/oneinbox/whatsapp/index.md

Whitespace-only changes.

docs/onelead/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Meta Integration for OneLead
2+
3+
OneLead provides **seamless integration with Meta (Facebook) Lead Ads**, ensuring that leads from your Facebook and Instagram campaigns are instantly available in your CRM.
4+
5+
## How It Works
6+
- **Captures leads** from Facebook Lead Forms via webhooks.
7+
- **Maps leads** to internal CRM structures based on configurations.
8+
- **Assigns leads** to users or teams automatically.
9+
- **Tracks lead performance** through analytics.
10+
11+
## Key Setup Steps
12+
1. **Register a Meta App** on the [Facebook Developer Portal](https://developers.facebook.com/).
13+
2. **Configure Webhooks** to receive real-time lead data.
14+
3. **Generate and validate User Access Tokens**.
15+
4. **Map Meta Ad Pages and Forms** inside OneLead.
16+
17+
For a complete guide on **Meta Webhook Configuration**, go to [Meta Webhook Config](meta_webhook_config.md).

docs/onelead/installation.md

Whitespace-only changes.

0 commit comments

Comments
 (0)