feat: add GitAgent and OpenGAP pages with full docs#1
Conversation
Add GitAgent product page, GitAgent docs (/docs/:section), and OpenGAP docs (/opengap/:section) with sidebar navigation, bump spec to v0.4.0, and clean up landing page sections and nav CTAs.
|
@Nivesh353 is attempting to deploy a commit to the shreyas-lyzr's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
shreyas-lyzr
left a comment
There was a problem hiding this comment.
Thanks @Nivesh353 — this is real progress and the structure is mostly there. A few things I want before this lands, mostly around how the SDK is presented and how Personal Assistant mode introduces itself. Inline comments below; here is the summary:
1. Split SDK and Personal Assistant into two parallel quickstarts. Right now both stories collapse into one Getting Started + Interfaces flow. They are two distinct entry points with different audiences (SDK = developer embedding it in an app; Personal Assistant = end user running it as a daily driver) and they deserve their own quickstarts side by side, each with its own steps and code.
2. The SDK quickstart needs two code paths, explicitly labeled.
- With an OpenGAP repo URL —
query({ repo: 'https://github.com/open-gitagent/opengap', prompt: '...' }). Cloned and configured for you. Zero setup, ideal for the first run. - Without a repo —
query({ prompt: '...', model: 'anthropic:claude-sonnet-4-6' }). Pure SDK, you bring your own context. Ideal for embedding inside an existing app.
Show both code snippets in the SDK section opening, not buried in tabs. Right now the section opens straight intoquery()/tool()/buildTool()/hooksAPI tabs and the reader has to figure out which path they are on.
3. Highlight SDK more prominently. Today SDK lives at Interfaces > SDK in the sidebar — that buries it. Either promote it to top-level under Getting Started as 'SDK Quickstart', or duplicate the quickstart there. The SDK is the production entry point and most people who matter to us land via it.
4. Personal Assistant out-of-the-box needs images. The Personal Assistant section is currently a code snippet next to text. If we want this to feel out-of-the-box, it needs at least one screenshot or short clip — terminal launch, voice prompt, the agent responding. Right now it competes for attention with the SDK tile and loses because both are gray text.
5. Cookbooks for the SDK. If we can add a /docs/sdk/cookbooks page with 4–6 recipes (refactor a repo, summarize unread emails, voice assistant for code review, custom tool, multi-agent handoff, scheduled cron task), that would be the best thing this PR could ship. Each cookbook = 20–30 lines of complete runnable code that calls the SDK end-to-end. Reading recipes is how I'd learn this SDK myself.
6. Tighten the prose. A few sections (Memory, Compliance, Tools) read like reference docs more than introductions — short sentences, one idea per paragraph, lead with the example. Easier to read on mobile too.
Nothing here is a blocker on the structural skeleton you have — these are all additive shifts. Happy to merge fast once the SDK split + Personal Assistant images land. Real thanks for the volume of work.
| }, | ||
| ]; | ||
|
|
||
| const setupModes = [ |
There was a problem hiding this comment.
setupModes here bundles the Personal Assistant path and the SDK path into one card grid. Split this into two clearly-labeled quickstarts at the section level: 'Personal Assistant Quickstart' (terminal + voice, target = end user) and 'SDK Quickstart' (npm install + import query, target = developer embedding in an app). Each should have its own install line, its own first-run command/snippet, and its own 'next step' link. Right now a new reader has to mentally separate which steps belong to which path.
| import { track } from "@/lib/analytics"; | ||
| import { CodeBlock } from "@/components/gitAgent/CodeBlock"; | ||
|
|
||
| const tabs = ["query()", "tool()", "buildTool()", "hooks"] as const; |
There was a problem hiding this comment.
The section opens straight into the API tabs (query(), tool(), buildTool(), hooks). That presumes the reader has already done setup and just needs the API reference. Before the tabs, please add a 'SDK Quickstart' block with TWO labeled code paths:
Path A — with OpenGAP repo URL (no local setup):
import { query } from "@open-gitagent/opengap";
for await (const msg of query({
repo: "https://github.com/open-gitagent/opengap",
prompt: "Run the LLM Wiki ingest on this paper",
model: "anthropic:claude-sonnet-4-6",
})) { if (msg.type === "assistant") console.log(msg.content); }Path B — without a repo (bring your own context):
import { query } from "@open-gitagent/opengap";
for await (const msg of query({
prompt: "Summarise yesterday's unread emails",
model: "anthropic:claude-sonnet-4-6",
})) { if (msg.type === "assistant") console.log(msg.content); }The two-path framing makes the SDK feel approachable. The API tabs become 'go deeper' rather than 'first encounter'.
| { type: "user", desc: "User message (multi-turn)", fields: "content" }, | ||
| ]; | ||
|
|
||
| export function GitAgentSDK() { |
There was a problem hiding this comment.
Visual prominence: SDK is the production entry point for most people who actually deploy this thing, but in the current sidebar it sits at Interfaces > SDK — same weight as Messaging. Two options I'd accept:
- Promote SDK to top-level in the sidebar (its own group, above Configuration).
- Duplicate the SDK Quickstart under
Getting Startedas its own sidebar item, with the full SDK reference staying where it is.
Either way, the SDK story should be discoverable on first sidebar scan, not nested two levels deep.
| label: "CLI", | ||
| tagline: "Terminal REPL", | ||
| desc: "The primary way to run GitAgent. Launch an interactive session pointed at your agent repo.", | ||
| code: `gitagent --dir ~/assistant`, |
There was a problem hiding this comment.
The Personal Assistant tile (CLI / Terminal REPL with gitagent --dir ~/assistant) needs at least one image — a screenshot of the running REPL, a short loop of voice mode in action, or a GIF of the agent responding. Right now it's gray code in gray text and it's the section that's supposed to feel most 'just-works'. Without a visual it does not.
| label: "SDK", | ||
| tagline: "Embed in Node.js", | ||
| desc: "Import GitAgent directly into your application. Use query() to send a prompt and get a response programmatically.", | ||
| code: `import { query } from "@open-gitagent/gitagent";\n\nfor await (const msg of query({\n prompt: "Summarise yesterday's tasks",\n dir: "./my-agent",\n})) {\n if (msg.type === "assistant") console.log(msg.content);\n}`, |
There was a problem hiding this comment.
Same point as above but flipped: SDK tile here has a real code snippet (good), but the package name is @open-gitagent/gitagent — please update to @open-gitagent/opengap to match the published name on npm (the gitagent alias still works, but opengap is the canonical name we ship as of v0.4.0).
Add GitAgent product page, GitAgent docs (/docs/:section), and OpenGAP docs (/opengap/:section) with sidebar navigation, bump spec to v0.4.0, and clean up landing page sections and nav CTAs.