Update docs for NeatContext 0.2.0 (context organizer, no in-app model) - #13
Merged
Conversation
NeatContext 0.2.0 hosts no model and no chat: it organizes team context and serves it to the AI client the user already works in (Claude Code, Claude Desktop, Codex CLI, ChatGPT Desktop) over a local MCP connection. The docs still described the removed "bring your own model, chat in tabs" architecture, so this brings every page in line with the shipped product. - intro / getting-started / core-concepts: reframe around Contexts + Library + connecting an external AI client; drop the model-provider step. - features: replace chats-and-tabs.md with contexts.md and model-provider.md with connect-ai-clients.md; add library.md and context-activity.md; update domain-profiles, knowledge-bases, using-extensions, account for the Library/Context model and per-call extension tool proxying. - guides/incident-analysis: two Contexts + a connected AI client instead of two in-app chat tabs. - extensions/* and guides: "the model in chat" / "top bar" / "Connect button in the chat" -> connected AI client, Context selection, and activity log. - category descriptions updated. Screenshots of removed UI (chat tabs, model provider, in-app answers) are no longer referenced; recapturing the Contexts page and AI-client connection cards is a follow-up.
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.
Why
NeatContext 0.2.0 hosts no model and no chat of its own. It organizes a team's context and serves it to the AI client the user already works in — Claude Code, Claude Desktop, Codex CLI, or ChatGPT Desktop — over a local MCP connection. That client reads the profiles, searches the knowledge folders, calls the extension tools, and writes the answer with its own model.
The published docs still described the removed architecture end-to-end: bring your own OpenAI-compatible model + API key, chat in tabs, streaming in-app answers. This PR brings every page in line with the shipped product (verified against
apps/desktopandneatcontext_design_doc.md).What changed
Core narrative
intro,getting-started,core-concepts— reframed around Contexts + Library + connecting an external AI client; the "connect your model" step is gone (there is no model config anywhere in the app).Features
chats-and-tabs.md→contexts.md(a Context is the unit of handoff, shown as a tab).model-provider.md→connect-ai-clients.md(Claude Code / Claude Desktop / Codex CLI / ChatGPT Desktop,get_context, live edits, runtime boundary).library.md(personal + read-only Team Library, extension install lifecycle) andcontext-activity.md(per-Context activity log + retention).domain-profiles,knowledge-bases,using-extensions,accountfor the Library/Context model and per-call, keychain-injected extension tool proxying.Guides & extension authoring
guides/incident-analysis— two Contexts + a connected AI client instead of two in-app chat tabs.extensions/*and the PagerDuty/Datadog guides — "the model in chat" / "top bar" / "Connect button in the chat" → connected AI client, Context selection, and activity log.connection_requirednow correctly describes the client relaying a "connect it first" prompt.Verification
npm run buildpasses locally (DocusaurusonBrokenLinks: throw→ no broken links; no MDX/admonition errors; all admonition titles use the required bracket syntax).Follow-up (not in this PR)