Docs: user-manual pass + Contexts screenshot, drop external links - #14
Merged
Conversation
- Add static/img/features/contexts-page.png, captured from the installed 0.2.0 desktop app: a populated Context (profile, knowledge folder, connected extension) plus the "Connect this context" panel with a card per AI client. Referenced from contexts.md and connect-ai-clients.md. - Remove the two external links to modelcontextprotocol.io (keep the "MCP (Model Context Protocol)" text). Docs link only to NeatContext sites and repositories.
Reframe the user-facing pages around what the user clicks and sees, and remove descriptions of how NeatContext works internally (this is a commercial product). - connect-ai-clients: drop "What the client receives", "Context pinning and live edits", "The runtime boundary", and the per-client mechanism notes; keep a short Connect steps list, an Ask-your-question section, and tips. - core-concepts: rewrite as a plain vocabulary + "how the pieces fit" overview; remove the model-free/MCP/tool-name/credential mechanism. - getting-started: connect/ask steps reduced to actions; fix prerequisite links. - intro / contexts / library / using-extensions / knowledge-bases / context-activity / incident-analysis: remove internal terms (get_context, MCP, proxying, keychain injection, runtime files, hooks, snapshots, file:// link details); state the user-relevant fact plainly instead.
tanglearncode
changed the title
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
1 participant
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.
Follow-up to #13. Three things, all in the user-facing docs.
1. User-manual pass (no internal details)
NeatContext is a commercial product, so the docs now read like a user manual: followable steps and what the user sees, not how NeatContext works internally. Removed from the user-facing pages:
connect-ai-clients.md.intro,core-concepts,getting-started,contexts,library,using-extensions,knowledge-bases,context-activity, andincident-analysis:get_context, MCP/transport, credential injection / keychain, extension proxying, runtime files, prompt hooks, snapshots,file://link internals.Each was replaced with the plain user-relevant fact (e.g. "credentials stay encrypted on your machine and are never exposed to the AI client", "no model or API key to set up"). The
docs/extensions/**authoring pages are left technical — they're a developer-integration reference for people writing connectors.2. Contexts page screenshot
Adds
static/img/features/contexts-page.png, captured from the installed 0.2.0 app: a populated Context plus the Connect this context panel (ChatGPT Desktop, Claude Desktop, Codex CLI, Claude Code CLI). Referenced fromcontexts.mdandconnect-ai-clients.md.3. External links
Removed the two
modelcontextprotocol.iolinks (kept the "MCP" text). Docs link only to NeatContext sites and theXTSoftwareLabs/neatcontext-demorepo.Verification
npm run buildpasses (no broken links; image resolves).