Add repository map document derivation#413
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d48d0380ba
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "Provide a table mapping important claims to Org links pointing at source evidence.")) | ||
|
|
||
| ;;;###autoload | ||
| (defun ai-code-derive-repo-map () |
There was a problem hiding this comment.
Register the repo-map command in the UI
This new interactive command is defined in a separate feature, but the main package still only requires ai-code-doc and ai-code-derive-architecture-document still dispatches over the old choices, so users who load ai-code and use C-c a A never see or load the repo-map generator. In that normal entry path, the feature advertised by this commit is effectively unreachable unless the user manually loads ai-code-doc-repo-map.el or calls an autoload generated outside this change; add the require and menu/dispatch entry alongside the other architecture document generators.
Useful? React with 👍 / 👎.
Summary
Add a new repository map document generator focused on codebase onboarding.
Unlike the C4 architecture overview, the repository map is intended to answer a more basic first-reader question:
What this adds
ai-code-doc-repo-map.elai-code-derive-repo-map.ai.code.files/architecture/repo-map.orgGenerated document structure
The prompt asks the AI backend to generate:
Design choices
file:links back to source evidence.Why
For unfamiliar repositories, contributors often need a fast, practical reading guide before they need a full architecture model. This command helps users and AI coding agents quickly identify:
This complements the existing architecture, DDD, test context, and C4 document generation commands.