Skip to content

docs: add a source-verified GraphAgent architecture overview - #702

Merged
LeXwDeX merged 1 commit into
mainfrom
docs/architecture-overview
Oct 5, 2026
Merged

LeXwDeX merged 1 commit into
mainfrom
docs/architecture-overview

Conversation

@LeXwDeX

@LeXwDeX LeXwDeX commented Oct 3, 2026

Copy link
Copy Markdown
Owner

Why

The Docs entry has no single overview of the current GraphAgent runtime. Readers need a map of the client transports, service composition, DAG execution, model calls, tools, and storage.

What changed

  • Add docs/architecture.md with a Mermaid overview, component responsibilities, and source links.
  • Add docs/architecture.html with the project's black-and-white architecture diagram.
  • Link the overview from both README files.

Evidence

Verify the overview against main at 10806c9ad7. Show AppLayer as service composition, distinguish HTTP requests from SSE events, and explain the default AI SDK path and opt-in native model path. Describe SQLite state separately from workspace files, Memory YAML, and managed artifacts.

  • Toolchain check: Bun 1.4.2, Node 24.21.0, Go 1.27.1.
  • Prettier check passes for the two new documents; existing README formatting was preserved.
  • All 64 checked local document/source links and line anchors resolve.
  • Diagram single-file and accessibility checks pass.
  • Chromium render checks pass for desktop, 390px mobile scrolling, and print layout.
  • Staged whitespace check and final Astra review pass.

Checklist

  • The document and diagram are under docs.
  • Both README files provide an entry point.
  • Source references and relative links resolve.
  • The diagram has accessible labels and supports desktop, mobile scrolling, and print layouts.
  • The pushed commit contains only these four documentation files.

Closes #701

@LeXwDeX
LeXwDeX marked this pull request as ready for review October 3, 2026 07:08
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-03T07:14:29.013138Z 057b52f Draft marked ready
🔒 Security Review ✅ Completed 2026-10-03T07:11:03.539208Z 057b52f Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 057b52f7ee

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/architecture.html
<g data-component="api">
<rect class="node" x="280" y="264" width="184" height="120" rx="6" />
<text class="node-name" x="300" y="292">HTTP API 与事件</text>
<text class="sublabel" x="300" y="316">Hono / Effect HttpApi</text>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove Hono from the runtime API label

The diagram places Hono inside the opencode service process, but the reviewed baseline constructs this server with Effect's HttpRouter and HttpApiApp (packages/opencode/src/server/server.ts:3-12,55-67,99-113), and packages/opencode has no Hono dependency or import; the repository's Hono usages belong to the unrelated packages/function and packages/enterprise services. This makes the source-verified overview direct readers toward a nonexistent runtime layer, so the label should describe only the Effect HTTP stack.

Useful? React with 👍 / 👎.

@LeXwDeX
LeXwDeX merged commit 0464b9e into main Oct 5, 2026
13 checks passed
@LeXwDeX
LeXwDeX deleted the docs/architecture-overview branch October 5, 2026 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add a source-verified GraphAgent architecture overview

1 participant