Skip to content

docs: sync README with ROADMAP, move docs to GitHub Wiki, add auto-sync workflow - #48

Merged
andriansandi merged 1 commit into
mainfrom
docs/readme-wiki-sync
Jul 2, 2026
Merged

andriansandi merged 1 commit into
mainfrom
docs/readme-wiki-sync

Conversation

@andriansandi

Copy link
Copy Markdown
Owner

Summary

  • Refreshed README.md to be a concise English landing page and synced feature roadmap with ROADMAP.md.
  • Moved detailed docs (deployment, development, architecture, MCP, FAQ, contributing, security, roadmap) to GitHub Wiki.
  • Created docs/API.md as the source-of-truth API reference.
  • Updated CONTRIBUTING.md to full English and fixed local dev ports/instructions.
  • Added .github/workflows/wiki-sync.yml + scripts/sync-wiki.js/sh to keep the Wiki auto-synced from the repo.
  • Added /wiki/ to .gitignore.

Manual setup required after merge

  1. Visit https://github.com/andriansandi/inbix/wiki and create the first "Home" page so GitHub initializes the wiki git repository.
  2. Add a repository secret named WIKI_PAT (PAT with repo scope) so the workflow can push to the wiki.

After that, every push to main will automatically sync the Wiki.

Verification

  • pnpm typecheck ✅
  • pnpm build ✅

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
inbix c3aaf1e Jul 02 2026, 03:43 AM

@andriansandi andriansandi self-assigned this Jul 2, 2026
@andriansandi
andriansandi merged commit e64bb2f into main Jul 2, 2026
5 checks passed
@andriansandi
andriansandi deleted the docs/readme-wiki-sync branch July 2, 2026 03:55
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