Comment by muzani
1 day ago
I put explanations of the code in other .md files. There's architecture.md, checklist.md, (feature).md, components.md, navigation.md.
These are designed to be easy for humans to read. There's also notes on things like deprecated libs to avoid, or how to use the design system. Get it to update things as they change.
Claude.md for me is a kind of directory to tell it what to read based on what it's trying to do.
Roadmap.md is one of my favorites. A lot of the problems that arise for both human and LLM coders is that we don't notice that there's tech debt or incomplete items. It's also easy to get back into 'flow' 7 months later.
No comments yet
Contribute on Hacker News ↗