docs: README overhaul with architecture diagram#246
Merged
Conversation
Contributor
|
🎉 PR Validation ✅ PASSED Commit: Checks:
Ready to merge! ✨ 🔗 View workflow run |
vreshch
marked this pull request as ready for review
July 7, 2026 22:31
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.
What
README overhaul plus a hand-authored architecture diagram, aligned to master after #238-#245. Ready as the npm landing page.
Touches only
README.mdanddocs/**- nosrc/,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 (stdioagentage mcp+ daemon HTTP/mcpon127.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.mdrestructured for a first-time reader: What is this -> Install -> Quickstart (local-only first, then optionalagentage 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--helpoutput. Corrected drift from the merged PRs:vault addnow defaults to an account vault;--local [path],--git <remote>,--path <dir>are the alternatives.vault sync [name]now covers git and the account channel; progress prints per vault.updatecommand and--no-daemonglobal flag.src/file paths (a sibling PR is movingsrc/sync/paths).Verification
npm run verifygreen: 405 unit tests pass, type-check + lint + format:check + build clean.dist/cli.js(vault add --local, write via stdin, list, search, read@vault/path) - all pass.docs/architecture.svgto PNG and eyeballed legibility.Note:
format:checkonly globs{src,e2e}/**/*.ts, so it does not lint markdown; README changes are prose-only.