docs: expand developer documentation and configuration guides#28
Open
docs: expand developer documentation and configuration guides#28
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Description
README.mdto add a concise “Why Context Sync?” section, improve install/auto-config notes, and index the richer docs.docs/CONFIG.mdwith a Manual Configuration Guide, platform-specific MCP snippets (Claude, Cursor, VS Code, Continue.dev, Zed, Windsurf, Codeium, TabNine, Codex CLI, Claude Code, Antigravity), validation checklist, and notes aboutnpxvs globalnodeusage.docs/TOOLS.mdinto a full developer tool reference describing the 9 core MCP tools, required tool flow, examples,remembercaveat metadata, common errors, and MCP prompts/resources.docs/DATA.mdto describe local-first storage, default paths, custom DB options (--db-pathandCONTEXT_SYNC_DB_PATH), migration/backup behavior, deletion, and security guidance.docs/NOTION_INTERGRATION.mdto clarify capabilities (read-only MCP support), step-by-step setup, sharing pages with the integration, and quick usage examples.docs/TROUBLESHOOTING.mdwith quick diagnostics, client-specific checks, clear core-tool errors, Notion troubleshooting, git-hook guidance, migration notes, and a ‘still stuck’ recovery step.docs/RELEASE_NOTES.mdcalling out the documentation expansion; committed all changes.Testing
Codex Task