Skip to content

docs: replace AI_KNOWLEDGE_BASE.md with concise AGENTS.md - #2

Merged
tahouse merged 1 commit into
mainfrom
docs/agents-md-consolidation
Jun 27, 2026
Merged

docs: replace AI_KNOWLEDGE_BASE.md with concise AGENTS.md#2
tahouse merged 1 commit into
mainfrom
docs/agents-md-consolidation

Conversation

@tahouse

@tahouse tahouse commented Jun 27, 2026

Copy link
Copy Markdown
Owner

Summary

  • Replace bloated AI_KNOWLEDGE_BASE.md (2,913 lines) with concise AGENTS.md (266 lines) containing only AI-essential context
  • Slim .cursorrules to a pointer referencing AGENTS.md
  • Update help_system.py to read from AGENTS.md
  • Update all cross-references across README, CONTRIBUTING, RELEASE_PROCESS, DEPRECATION
  • Clean up stale TODO.md (mark v0.3-v0.6 features as completed, fix release planning)
  • Fix CI failure: remove fragile test_version_module_type_checking_true that assumed setuptools-scm's _version.py always contains TYPE_CHECKING

Test plan

  • All 538 tests pass locally
  • All pre-commit hooks pass (ruff, mypy, pytest)
  • python -m wry.help_system ai correctly serves AGENTS.md
  • python -m wry.help_system sources correctly extracts section
  • No dangling references to AI_KNOWLEDGE_BASE.md in code (only CHANGELOG.md historical entries)

- Create AGENTS.md (266 lines) replacing AI_KNOWLEDGE_BASE.md (2,913 lines)
  with only AI-essential context: architecture overview, critical gotchas,
  development rules, key patterns, and debugging reference
- Slim .cursorrules to a pointer referencing AGENTS.md
- Update help_system.py to read from AGENTS.md instead of AI_KNOWLEDGE_BASE.md
- Update all cross-references (README, CONTRIBUTING, RELEASE_PROCESS, DEPRECATION)
- Clean up stale TODO.md (mark completed v0.3-v0.6 features, fix release planning)
- Fix CI: remove fragile test_version_module_type_checking_true that assumed
  setuptools-scm's _version.py always contains TYPE_CHECKING attribute
@tahouse tahouse self-assigned this Jun 27, 2026
@tahouse
tahouse merged commit b87b408 into main Jun 27, 2026
14 checks passed
@tahouse
tahouse deleted the docs/agents-md-consolidation branch June 27, 2026 00:55
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