Hacker News new | past | comments | ask | show | jobs | submit login

The best way I like documentation is via a docs/ directory within the repo. Uing js-sequence-diagrams ( https://bramp.github.io/js-sequence-diagrams/ ) to create self-contained one page diagrams (like this https://jsbin.com/jusiyusowu/edit?output ) which go into code.

That allowed me to include documentation updates in the code review.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: