Skip to content

docs: README overhaul with architecture diagram#246

Merged
vreshch merged 1 commit into
masterfrom
docs/readme-architecture
Jul 7, 2026
Merged

docs: README overhaul with architecture diagram#246
vreshch merged 1 commit into
masterfrom
docs/readme-architecture

Conversation

@vreshch

@vreshch vreshch commented Jul 7, 2026

Copy link
Copy Markdown
Member

What

README overhaul plus a hand-authored architecture diagram, aligned to master after #238-#245. Ready as the npm landing page.

Touches only README.md and docs/** - no src/, package.json, or workflows.

Changes

  • docs/architecture.svg - hand-written SVG (no render tooling). Neutral background with dark text on light boxes, so it reads in both light and dark GitHub themes and on npm. Shows AI tools -> MCP (stdio agentage mcp + daemon HTTP /mcp on 127.0.0.1:4243) -> CLI + local daemon (single writer) -> local vaults (git-per-vault, @agentage/memory-core) -> sync out to git remotes and account sync (labeled protocol-neutrally, no internal tech named).
  • README.md restructured for a first-time reader: What is this -> Install -> Quickstart (local-only first, then optional agentage setup) -> Architecture (diagram) -> Command reference -> Sync -> MCP integration -> Daemon -> Env vars -> Development.
  • docs/architecture.md - short walk-through of the diagram.

Reality-check vs master

Built the CLI (npm run build) and verified every command and flag against the live --help output. Corrected drift from the merged PRs:

Verification

  • npm run verify green: 405 unit tests pass, type-check + lint + format:check + build clean.
  • Ran the offline quickstart end-to-end against the built dist/cli.js (vault add --local, write via stdin, list, search, read @vault/path) - all pass.
  • Rendered docs/architecture.svg to PNG and eyeballed legibility.

Note: format:check only globs {src,e2e}/**/*.ts, so it does not lint markdown; README changes are prose-only.

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

🎉 PR Validation ✅ PASSED

Commit: 54c529d9bb1ceb12ba0b0a992fc434e0d0930ea1
Branch: docs/readme-architecture

Checks:

  • ✅ Release guard (no version/changelog changes)
  • ✅ Dependencies installed
  • ✅ Type check passed
  • ✅ Linting passed
  • ✅ Format check passed
  • ✅ Tests + coverage passed
  • ✅ Build successful

Ready to merge!


🔗 View workflow run
⏰ Generated at: 2026-07-07T22:29:33.087Z

@vreshch
vreshch marked this pull request as ready for review July 7, 2026 22:31
@vreshch
vreshch merged commit 72bf911 into master Jul 7, 2026
3 checks passed
@vreshch
vreshch deleted the docs/readme-architecture branch July 7, 2026 22:31
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.

1 participant