docs: Cloud-first README + move internals to docs/#46
Conversation
- Trim README to end-user setup: hosted Cloud OAuth + per-client connect instructions (Claude Code/Desktop, Cursor, VS Code, Codex, OpenCode, Windsurf) - Move reference material into docs/: tool-surface, authentication, documentation-search, self-hosted, development - Drop outdated integration screenshots (showed the old 42-tool surface and leaked API keys/PII); keep brand logos and add a centered README header
Greptile SummaryThis is a documentation-only refactor that rewrites the README to be Cloud-first and moves the detailed reference content into a new
Confidence Score: 5/5Safe to merge — all changes are documentation and assets with no effect on runtime behaviour. The PR touches only Markdown files and binary images. The new docs correctly describe the server's existing behaviour, and the removed screenshots no longer leak credentials. The one nit in docs/self-hosted.md is a minor copy clarification that doesn't affect any running code. The Important Files Changed
Reviews (2): Last reviewed commit: "(docs): simplify docs — trim redundant t..." | Re-trigger Greptile |
What
Refactors the README to be straight-to-the-point for end users, centered on Appwrite Cloud, and moves the internal/reference documentation into a new
docs/folder.Changes
README (Cloud-first, end-user focused)
https://mcp.appwrite.io/mcp) and browser OAuth.<picture>).New
docs/foldertool-surface.md— operator surface + internal catalogauthentication.md— the Cloud OAuth 2.1 flowdocumentation-search.md—appwrite_search_docs+ index rebuildself-hosted.md— per-client stdio setup with a project API keydevelopment.md— running, testing, debugging (cross-links AGENTS.md)Removed images
cursor,claude-desktop,vs-code,windsurf). They were outdated — they showed the old 42-tool surface (contradicting the current compact ≤4-tool design) and the stdio/API-key flow, and leaked liveAPPWRITE_API_KEYvalues and user PII.Notes