Skip to content

Commit f2b8df3

Browse files
authored
docs: purge wiki, establish docs/ as single source of truth, and fix sync workflow (#20)
1 parent ecdb2c0 commit f2b8df3

17 files changed

Lines changed: 14 additions & 649 deletions

‎.github/workflows/sync-docs.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
push:
55
branches:
66
- master
7+
- main
78
paths:
89
- "docs/**"
910
- ".github/workflows/sync-docs.yml"
@@ -23,6 +24,11 @@ jobs:
2324
env:
2425
DOCS_TOKEN: ${{ secrets.DOCS_SYNC_PAT || secrets.GH_PAT || secrets.GITHUB_TOKEN }}
2526
run: |
27+
if [ -z "$DOCS_TOKEN" ]; then
28+
echo "::error::DOCS_SYNC_PAT or GITHUB_TOKEN is not configured."
29+
exit 1
30+
fi
31+
2632
git config --global user.name "github-actions[bot]"
2733
git config --global user.email "github-actions[bot]@users.noreply.github.com"
2834

‎.github/workflows/wiki-sync.yml‎

Lines changed: 0 additions & 47 deletions
This file was deleted.

‎README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
[![MongoDB](https://img.shields.io/badge/Database-MongoDB-47A248?style=flat-square&logo=mongodb)](https://www.mongodb.com/)
1212
[![Tailwind CSS v4](https://img.shields.io/badge/Tailwind-CSS_v4-38B2AC?style=flat-square&logo=tailwind-css)](https://tailwindcss.com/)
1313

14-
[⚡ Quick Start](#-quick-start-1-command) • [🚀 Deploy on PaaS](#-1-click-paas-deployment) • [✨ Key Features](#-key-features) • [📖 Documentation](#-documentation--wiki) • [🛠️ Configuration](#%EF%B8%8F-configuration)
14+
[⚡ Quick Start](#-quick-start-1-command) • [🚀 Deploy on PaaS](#-1-click-paas-deployment) • [✨ Key Features](#-key-features) • [📖 Documentation](#-documentation) • [🛠️ Configuration](#%EF%B8%8F-configuration)
1515

1616
</div>
1717

@@ -139,10 +139,11 @@ This project follows an automated semantic CI/CD versioning lifecycle directly c
139139

140140
---
141141

142-
## 📖 Documentation & Wiki
142+
## 📖 Documentation
143143

144-
Detailed guides are available in the [`/docs`](docs/) directory:
144+
Comprehensive guides and interactive documentation are hosted on the **[Documentation Website](https://instagram-saved-posts.app/docs)** and maintained in the [`/docs`](docs/) directory as the single source of truth:
145145

146+
- 🌐 **[Interactive Documentation Website](https://instagram-saved-posts.app/docs)**
146147
- 🔑 [How to Get Your Instagram Cookie](docs/getting-started/how-to-get-instagram-cookie.md)
147148
- 🐳 [Docker Compose Deployment Guide](docs/deployment/docker-compose.md)
148149
- 🟣 [Dokploy Self-Hosting Guide](docs/deployment/dokploy.md)

‎docs/deployment/coolify.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ description: "Deploy Instagram Saved Posts Tracker on Coolify PaaS with 1-click
1717
3. Select **Docker Compose**.
1818

1919
### Step 2: Paste Configuration
20-
Paste the contents of [`coolify-compose.yml`](../../coolify-compose.yml):
20+
Paste the contents of [`coolify-compose.yml`](https://github.com/gitnasr/Instagram-Saved-Posts/blob/master/coolify-compose.yml):
2121

2222
```yaml
2323
version: "3.8"

‎docs/deployment/dokploy.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ description: "Deploy as a multi-service stack with automated Traefik SSL on Dokp
1717
3. Click **Add Service** -> Select **Compose**.
1818

1919
### Step 2: Configure Compose Stack
20-
1. In the Compose Configuration editor, paste the contents of [`dokploy-compose.yml`](../../dokploy-compose.yml):
20+
1. In the Compose Configuration editor, paste the contents of [`dokploy-compose.yml`](https://github.com/gitnasr/Instagram-Saved-Posts/blob/master/dokploy-compose.yml):
2121

2222
```yaml
2323
version: "3.8"

‎docs/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ Saved Posts Tracker addresses every one of these problems with a unified, self-h
4242

4343
## Next Steps
4444

45-
- Check out the [Quickstart Guide](/docs/quickstart) to deploy in 5 minutes.
46-
- Learn about the [System Architecture](/docs/architecture).
45+
- Check out the [Quickstart Guide](/docs/getting-started/quickstart) to deploy in 5 minutes.
46+
- Learn about the [System Architecture](/docs/architecture/system-overview).
4747
---
4848

4949
## 🗺️ Documentation Index

‎wiki/Backup-and-Database-Migration.md‎

Lines changed: 0 additions & 43 deletions
This file was deleted.

‎wiki/Cloudinary-Permanent-Media-CDN.md‎

Lines changed: 0 additions & 52 deletions
This file was deleted.

‎wiki/Coolify-Self-Hosting-Guide.md‎

Lines changed: 0 additions & 68 deletions
This file was deleted.

‎wiki/Docker-Compose-Deployment.md‎

Lines changed: 0 additions & 94 deletions
This file was deleted.

0 commit comments

Comments
 (0)