Skip to content

docs: remove stale memory-bank references and clarify the transient todo.md - #879

Merged
TomKaltofen merged 1 commit into
mloda-ai:mainfrom
dchaudhari7177:docs/stale-memory-bank-refs
Jul 28, 2026
Merged

docs: remove stale memory-bank references and clarify the transient todo.md#879
TomKaltofen merged 1 commit into
mloda-ai:mainfrom
dchaudhari7177:docs/stale-memory-bank-refs

Conversation

@dchaudhari7177

Copy link
Copy Markdown
Contributor

All three references from the issue, each verified against main before touching it.

1. tests/README.mdtest_memory_bank/

The layout tree listed a test_memory_bank/ directory. There is no such directory under tests/. Removed the line.

2. test_link_on_methods.py — dead design-decision path

The module docstring's See Also pointed at /memory-bank/design-decisions/joinspec-convenience-function.md. Neither that file nor the memory-bank/design-decisions/ directory exists on main.

Dropped that line and kept GitHub Issue #133: JoinSpec Convenience Function, which still resolves — so the docstring keeps a working pointer to the rationale rather than losing the context entirely.

3. todo.md in the Phase Completion Protocol

The protocol read as though memory-bank/todo.md were a standing file, which sits oddly next to the slimmed Memory Bank section.

I clarified rather than dropped it: the protocol itself is still used, it's only the file's status that was unstated. Both files now say up front that todo.md is transient — created for the duration of a phased task, removed when the work lands, and therefore not one of the Memory Bank core files — before listing the steps.

CLAUDE.md and AGENTS.md are kept in sync (I diffed the two sections to confirm they're identical).

Note on overlap

This deliberately avoids the Memory Bank / core-files section that #877 is rewriting — the only shared files are CLAUDE.md/AGENTS.md, and this change is confined to the Phase Completion Protocol section, which #877 doesn't touch. So the two should merge cleanly in either order.

I did not touch #873's two catalog files, since #877 already removes them.

Checks

ruff format --check --line-length 120 (597 files already formatted) and ruff check both clean; tests/test_core/test_setup/test_link_on_methods.py — 18 passed. Docs/comments only, no behaviour change.

Closes #878

…odo.md

Three references pointed at memory-bank paths that do not exist:

- tests/README.md listed a test_memory_bank/ directory that is not in the tests
  tree; removed from the layout.
- tests/test_core/test_setup/test_link_on_methods.py pointed its See Also at
  /memory-bank/design-decisions/joinspec-convenience-function.md, which does not
  exist on main; dropped the line and kept the GitHub issue reference, which
  still resolves.
- CLAUDE.md and AGENTS.md described the Phase Completion Protocol as if
  memory-bank/todo.md were a standing file. Clarified that it is transient —
  created for a phased task, removed when the work lands, and not one of the
  Memory Bank core files — rather than dropping a protocol that is still used.

CLAUDE.md and AGENTS.md are kept in sync.

Closes mloda-ai#878
@TomKaltofen
TomKaltofen merged commit 388508c into mloda-ai:main Jul 28, 2026
34 of 35 checks passed
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: stale memory-bank references in tests and the phase protocol

2 participants