Hacker News
new
|
past
|
comments
|
ask
|
show
|
jobs
|
submit
login
xtracto
on Nov 26, 2018
|
parent
|
context
|
favorite
| on:
Ask HN: Is there a better way to document complex ...
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:
That allowed me to include documentation updates in the code review.