Not an example for a good codebase but given most people who read this work on their own doc pages:
The #1 rule for documentation is that it has to be autogenerated and/or automatically tested.
As soon as it has to be manually updated and/or it's external from your codebase people won't do it.
Eg. your api docs should be generated with your automatic tests. At @producthunt we use eg github.com/zipmark/rspec_api_docum... for this.
Are you sure you want to hide this comment? It will become hidden in your post, but will still be visible via the comment's permalink.
Hide child comments as well
Confirm
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
Not an example for a good codebase but given most people who read this work on their own doc pages:
The #1 rule for documentation is that it has to be autogenerated and/or automatically tested.
As soon as it has to be manually updated and/or it's external from your codebase people won't do it.
Eg. your api docs should be generated with your automatic tests. At @producthunt we use eg github.com/zipmark/rspec_api_docum... for this.