logoalt Hacker News

thatxlinertoday at 3:17 AM2 repliesview on HN

I'm wanting to read this repository as a learning tool, so it'd also be nice to include docs—even AI-generated docs, but obvious I'd prefer docs with your own design notes and decisions—about the architecture of the code.

Really cool project though!


Replies

imtomttoday at 3:23 AM

Thanks, I appreciate it a lot! I tried to comment my code pretty heavily (~3000 lines of code, ~1000 lines of comments all together), since this was a learning project for myself in the first place. Hopefully those will be of some use. But separate in-depth documentation is definitely a good idea, I'll work on adding that. In the meantime I'm always down to answer any questions about it!

show 2 replies
vascotoday at 5:46 AM

If you'd be happy with that then you can generate them yourself!