3 ms·
Does a README in every folder in a Github repo meet the requirements? What is the lowest friction way to do this?
by carom 4y ago
Does a README in every folder in a Github repo meet the requirements? What is the lowest friction way to do this?
- origin_path 4y agoProbably 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.
- carom 4y agoHa, 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_path 4y agoSure. 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.