Skip to content

docs: update AGENTS.md with complete module listing - #579

Closed
arnoldwender wants to merge 4 commits into
MemPalace:developfrom
arnoldwender:docs/update-agents-md
Closed

docs: update AGENTS.md with complete module listing#579
arnoldwender wants to merge 4 commits into
MemPalace:developfrom
arnoldwender:docs/update-agents-md

Conversation

@arnoldwender

Copy link
Copy Markdown
Contributor

Summary

  • Updated project structure to list all 27 modules (was 12)
  • Added missing top-level directories (docs/, integrations/)
  • Fixed coverage threshold: 85% → 80% (matches actual CI config)
  • Added key file references for entity detection, memory layers, and palace maintenance

Why

AGENTS.md listed 12 out of 27 modules, missing important files like layers.py, dedup.py, migrate.py, repair.py, entity_detector.py, and entity_registry.py. Contributors looking for where to make changes couldn't find the right file from the docs.

Test plan

  • No code changes — documentation only
  • Module list verified against ls mempalace/*.py
  • Directory list verified against ls -d */
  • Coverage threshold verified against .github/workflows/ci.yml

@web3guru888 web3guru888 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.

Clean and necessary update — 27 modules listed vs the old 12 is a significant gap that would trip up new contributors.

The additions are all legitimate modules (layers.py, dedup.py, migrate.py, repair.py, entity_detector.py, entity_registry.py) that do real work and deserve documentation. The coverage threshold correction (85% → 80%) matching actual CI config is a good catch too.

LGTM.


[MemPalace-AGI integration — 215 tests, 710 KG entities]

@web3guru888 web3guru888 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.

Clean, accurate docs update. LGTM.


[MemPalace-AGI integration — 215 tests, 710 KG entities]

@web3guru888 web3guru888 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.

LGTM — the expanded module listing is much more useful for contributors trying to locate the right file. The coverage threshold fix (85% → 80%) is correct; CI was already at 80% so this removes a confusing discrepancy.

Two small observations (non-blocking):

  • The description on still says "ChromaDB access" — that will become stale if #574/575 land and the backend abstraction moves there. Worth updating proactively to "backend-agnostic storage access" or similar.
  • could note it's primarily for rollback scenarios (chromadb automatically handles upgrades from 0.4.1+), which #581 makes more salient.

@bensig
bensig changed the base branch from main to develop April 11, 2026 22:21
@bensig
bensig requested a review from igorls as a code owner April 11, 2026 22:21
@arnoldwender

Copy link
Copy Markdown
Contributor Author

Rebased onto develop — test file restored, version.py synced to 3.2.0. Triggering fresh CI.

@arnoldwender

Copy link
Copy Markdown
Contributor Author

Closing to reopen as a fresh PR so CI can run (PR was stuck at 'action_required' from first submission — upstream approval gate never cleared).

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.

2 participants