4 ms·
Disagree on the readme.md. At work, we recently moved away from dedicated project/component documentation pages and toward readme.md. It's the best way to ensu
by hliyan 8y ago
Disagree on the readme.md. At work, we recently moved away from dedicated project/component documentation pages and toward readme.md.
It's the best way to ensure that the documentation is in sync with the implementation: the developer is more likely to update the readme.md in the same pull request he/she changes the implementation.
On Github, I seldom read the market-y website. I click the "Fork me on Github" link and go to the documentation pages on the source itself. It's the most reliable, in my view.
- namanyayg 8y agoLikewise, I always consult the GitHub docs (usually README.md) and code rather than see the website (which is sometimes out of sync) but usually projects which do not have a dedicated website do not have good READMEs either. This is my experience with full-stack JavaScript libraries/plugins.
- Ayesh 8y agoAlso helps when you have to work offline. I work on projects while I travel, and I always force my package manager to download the source (not dist) version of the package. The readme files are now included in the project, and it's a lot easier to just read them. Add an MD viewer to the IDE to make things easier.