Skip to content

docs: purge wiki, establish docs/ as single source of truth, and fix … - #21

Closed
gitnasr wants to merge 1 commit into
masterfrom
chore/purge-wiki-single-source-docs
Closed

gitnasr wants to merge 1 commit into
masterfrom
chore/purge-wiki-single-source-docs

Conversation

@gitnasr

@gitnasr gitnasr commented Sep 4, 2026

Copy link
Copy Markdown
Owner

…sync workflow

📋 Description

Provide a brief summary of the changes introduced by this pull request.


🔍 Type of Change

  • 🚀 New feature (non-breaking change that adds functionality)
  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • 🧰 Refactoring / Code cleanup (no functional changes)
  • 📖 Documentation update
  • ⚙️ CI/CD or Build pipeline improvement

🧪 Verification & Testing

Describe how this change was tested and verified:

  • npm run lint passes with 0 errors
  • npx tsc --noEmit passes with 0 errors
  • npm run build succeeds
  • Tested manually in development / Docker environment

Summary by CodeRabbit

  • Documentation

    • Updated documentation navigation and links to reflect the hosted documentation structure.
    • Corrected deployment guide links for Coolify and Dokploy.
    • Removed the legacy wiki guides, homepage, sidebar, and footer.
  • Chores

    • Documentation synchronization now supports both primary branch names.
    • Added validation for required documentation synchronization credentials.
    • Removed the obsolete wiki synchronization workflow.

@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: d9d1bd69-df9a-4500-bdae-bfbc9e5a1761

📥 Commits

Reviewing files that changed from the base of the PR and between ac223f3 and b151a64.

📒 Files selected for processing (17)
  • .github/workflows/sync-docs.yml
  • .github/workflows/wiki-sync.yml
  • README.md
  • docs/deployment/coolify.md
  • docs/deployment/dokploy.md
  • docs/index.md
  • wiki/Backup-and-Database-Migration.md
  • wiki/Cloudinary-Permanent-Media-CDN.md
  • wiki/Coolify-Self-Hosting-Guide.md
  • wiki/Docker-Compose-Deployment.md
  • wiki/Dokploy-Self-Hosting-Guide.md
  • wiki/Home.md
  • wiki/How-to-Get-Your-Instagram-Cookie.md
  • wiki/Reverse-Proxy-and-Authentik-SSO.md
  • wiki/Troubleshooting-and-FAQ.md
  • wiki/_Footer.md
  • wiki/_Sidebar.md

📝 Walkthrough

Walkthrough

The change transitions documentation away from the repository wiki. It updates documentation navigation and deployment links, adds a main trigger to the documentation sync workflow, validates DOCS_TOKEN, and removes wiki content and synchronization.

Changes

Documentation transition

Layer / File(s) Summary
Documentation navigation and links
README.md, docs/index.md, docs/deployment/coolify.md, docs/deployment/dokploy.md
The README identifies the hosted documentation site and updates its section anchor. The documentation index uses updated page paths. Deployment guides use absolute compose-file URLs.
Publishing workflow
.github/workflows/sync-docs.yml, .github/workflows/wiki-sync.yml
The documentation sync runs on pushes to master and main. It stops with an error when DOCS_TOKEN is missing. The wiki synchronization workflow is removed.
Wiki content removal
wiki/*
The wiki homepage, navigation, deployment, operations, authentication, media, backup, and troubleshooting pages are removed.

Estimated code review effort: 2 (Simple) | ~10 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/purge-wiki-single-source-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@gitnasr gitnasr closed this Sep 4, 2026
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

🧪 Beta Container Ready for Testing

A preview beta version has been built for this Pull Request:

  • Beta Version: 1.3.1-beta.21
  • Docker Tag: ghcr.io/gitnasr/instagram-saved-posts:beta-pr-21
  • Rolling Beta Tag: ghcr.io/gitnasr/instagram-saved-posts:beta
# Test this PR build locally:
docker pull ghcr.io/gitnasr/instagram-saved-posts:beta-pr-21

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant