{"path":"wiki/README.md","size":2810,"locked":false,"binary":false,"truncated":false,"content":"# Mappers Protocol Documentation (`docs/wiki/`)\n\nThis directory is the **tracked, version-controlled source of truth** for the Mappers Protocol wiki. The pages are reviewed with repository changes and synchronized to the GitHub Wiki by `.github/workflows/wiki-sync.yml` after changes land on `main`.\n\n## Pages\n\n| File                                           | Purpose                                                                       |\n| ---------------------------------------------- | ----------------------------------------------------------------------------- |\n| [`Home.md`](Home.md)                           | Protocol overview, current component status, and roadmap                      |\n| [`Architecture.md`](Architecture.md)           | System design, PDA architecture, state machine, and security model            |\n| [`Getting-Started.md`](Getting-Started.md)     | Prerequisites, workspace setup, services, and validation commands             |\n| [`SDK-Reference.md`](SDK-Reference.md)         | SDK classes, types, PDA helpers, and usage examples                           |\n| [`API-Reference.md`](API-Reference.md)         | REST endpoints and request/response conventions                               |\n| [`Dashboard.md`](Dashboard.md)                 | Frontend features and development guidance                                    |\n| [`Development-Guide.md`](Development-Guide.md) | Workspace workflow, code generation, database, Anchor, and Oracle development |\n| [`Release-Notes.md`](Release-Notes.md)         | Release history and v0.1.0 baseline                                           |\n| [`Glossary.md`](Glossary.md)                   | Protocol terms, accounts, roles, states, and error codes                      |\n| [`_Sidebar.md`](_Sidebar.md)                   | GitHub Wiki navigation                                                        |\n| [`_Footer.md`](_Footer.md)                     | GitHub Wiki footer                                                            |\n\n## Publishing to GitHub Wiki\n\nThe filenames follow GitHub Wiki conventions: `Home.md` is the landing page, `_Sidebar.md` and `_Footer.md` are special files, and page names use hyphens. The sync workflow copies only the contents of `docs/wiki/` into the repository wiki, so unrelated repository documentation is not published as wiki pages.\n\nThe workflow requires the repository Wiki to have been initialized once from GitHub’s **Wiki** tab. For a manual recovery or first-time setup:\n\n```bash\ngit clone https://github.com/mrphatom/mappers_contract.wiki.git\ncp docs/wiki/*.md mappers_contract.wiki/\ncd mappers_contract.wiki\ngit add .\ngit commit -m \"Sync wiki from docs/wiki/\"\ngit push\n```\n\nUpdate pages in `docs/wiki/` first. The GitHub Wiki is a downstream publication of those tracked files.\n"}