Skip to content

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

Merged
gitnasr merged 1 commit into
masterfrom
chore/purge-wiki-single-source-docs
Sep 4, 2026
Merged

gitnasr merged 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

    • Documentation is now centered on the hosted documentation website and the /docs directory.
    • Updated documentation navigation and links for Quickstart, System Architecture, Coolify, and Dokploy deployment guides.
    • Removed the repository wiki, including its deployment, troubleshooting, backup, authentication, and setup guides.
  • Chores

    • Documentation synchronization now supports pushes to main and reports a clear error when no documentation token is configured.

@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: 6c79bee5-c7cd-48a4-af49-7adc3d7081a2

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between ecdb2c0 and fc6aaf0.

πŸ“’ 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 updates documentation synchronization for both primary branches, adds token validation, redirects documentation links to new hosted and repository paths, and removes the repository wiki workflow and wiki content.

Changes

Documentation migration

Layer / File(s) Summary
Documentation synchronization workflow
.github/workflows/sync-docs.yml
The workflow now runs for main and master. It fails before cloning when DOCS_TOKEN is not configured.
Documentation navigation and links
README.md, docs/index.md, docs/deployment/*.md
README documentation links, documentation routes, and deployment configuration links now use the updated hosted or repository URLs.
Repository wiki removal
wiki/*.md, wiki/_Footer.md, wiki/_Sidebar.md, .github/workflows/wiki-sync.yml
The wiki synchronization workflow, wiki guides, footer, and sidebar content were 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 merged commit f2b8df3 into master Sep 4, 2026
3 of 4 checks passed
@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.2.4-beta.20
  • Docker Tag: ghcr.io/gitnasr/instagram-saved-posts:beta-pr-20
  • 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-20

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