undefined | Better HN

0 pointsorigin_path3y ago0 comments

Probably not IMO, it's very unlikely your source tree is structured the same way good docs should be. Docs are often task oriented, code is usually component oriented.

0 comments

carom3y ago

Ha, my tasks are usually updating those components. Mostly interested in developer efficacy. It is a real pain to find and reverse engineer components when starting a new gig. Would be nice to have an explanation and links to other components they interact with.

origin_pathOP3y ago

Sure. I tend to prefer a docsite generated using a rendering tool because when the docs look and feel high quality/high effort, people take it more seriously. But it can be that a README file in a set of directories is OK too. Chrome does this for example.

j / k navigate · click thread line to collapse

0 comments

carom3y ago

origin_pathOP3y ago

j / k navigate · click thread line to collapse