chore: remove tracked artifacts (.proofs, changelog-content.md, test-results)#238
Merged
Conversation
…results) Ignore them going forward; release-prepare.yml still writes changelog-content.md to the workspace but git add -A no longer commits it.
Contributor
|
🎉 PR Validation ✅ PASSED Commit: Checks:
Ready to merge! ✨ 🔗 View workflow run |
vreshch
added a commit
that referenced
this pull request
Jul 7, 2026
## 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: - `vault add` now 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. - Documented the `update` command and `--no-daemon` global flag. - Daemon section notes the loopback-only, token-guarded, cross-origin-rejecting API and port-in-use reporting (#243, #244). - Friendly memory errors + non-zero exits (#240); 64 KB read clamp and secret refusal. - Describes no specific `src/` file paths (a sibling PR is moving `src/sync/` paths). ## 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.
vreshch
added a commit
that referenced
this pull request
Jul 7, 2026
## Review-readiness sweep (post #238-#247) Fresh-reviewer pass over the whole repo after the 10-PR merge burst. The repo held up well; this PR carries the one actionable finding, plus a clean bill of health on the rest. ### Fixed - **`src/commands/memory.ts` was 207 lines** (over the 200 bar). Split along its natural seam: the six `run*` verb flows + their helpers move to `src/commands/memory-verbs.ts` (133 lines); `memory.ts` keeps the commander wiring + error `guard` (81 lines). Test import retargeted to `./memory-verbs.js`. No behavior change. ### Checked, nothing to fix - **Cross-PR seams:** no stale path refs (e.g. no lingering `src/sync/cycle.ts`), no duplicated helpers (`redactRemoteUrl` lives once in `sync/git/remote-url.ts`, imported by all five callers). - **File/naming bar:** all other src files <=200 lines, all kebab-case, no default exports, no `any` outside tests. - **Comments:** no `TODO`/`FIXME`/`XXX`, no commented-out code. Multi-line comment blocks that remain are load-bearing security/concurrency WHY notes (e.g. the `ext::` transport-helper RCE guard, the cross-process `mutateVaultsConfig` invariant) - collapsing them would lose signal, left as-is. - **Docs accuracy:** README, `docs/architecture.md` (vs `architecture.svg`), and CLAUDE.md layout all cross-checked against source - 20+ claims (flags, env vars, `4243` port, `0600` auth.json, six MCP tools, conflict-file naming) all verified, zero mismatches, zero typos, zero em dashes. - **CLI surface:** ran the built `dist/cli.js` help for every subcommand in an isolated HOME - consistent tone, no typos. `npm run verify` green; `test:coverage` green (85.5% stmts, above the 65/70/70/70 thresholds).
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
1 participant
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.
Removes tracked build/PR artifacts from the repo:
.proofs/- PR proof screenshots + render script (proofs belong on orphan branches, not master)changelog-content.md- per-release scratch file written by release-prepare.yml; still written to the workspace at release time, but now ignored sogit add -Astops re-committing ittest-results/.last-run.json- Playwright artifactAdds
.gitignoreentries:test-results/,playwright-report/,.proofs/,changelog-content.md.