-
Notifications
You must be signed in to change notification settings - Fork 1
chore: add claude code documentation files #467
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a final version? If so, duplicate this content to https://github.com/xability/maidr/blob/bfd94c750052b8935086414d143ff4a21b858c79/.github/copilot-instructions.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we have this separate document here? does it do something else than what CLAUDE.md does?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
professor, the main idea was to keep CLAUDE.md smaller so that context window doesn't bloat, For most of the fixes, the information in CLAUDE.md should be sufficient, but for debugging bigger issues we can reference detailed documentation, so that it would have a better understanding. This was the reco from anthropic as well. Please let me know your thoughts on this. Thanks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does claude code require debugging document under docs folder?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The same reason: Why do we keep this file separately here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
professor, do you think we should keep patterns inside ARCHITECTURE itslef rather than a separate file?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
We need to also make this CLAUDE.md accessible to claude code review workflow yaml. We can also try to reduce the verbose in code reviews as it's very superfluous
Pull Request
Description
Addition of CLAUDE.md for claude code context and documentation in docs/ folder for context to LLM's
Changes Made
Addition of CLAUDE.md, docs/ARCHITECTURE.md, docs/DEBUGGING.md, docs/PATTERNS.md
Checklist
ManualTestingProcess.md, and all tests related to this pull request pass.Additional Notes