DEV Community

Discussion on: Where is the best place to put your project documentation?

squgeim profile image
Shreya Dahal

What is your process to make sure the documentation is up to date with the codebase? I prefer to keep documentation on implementation detail in the codebase itself (MD files). This way a documentation update can be part of the code review and are always in sync with what branch you are working in.

chrisrhymes profile image
C.S. Rhymes Author

Good point! It’s always important to keep documentation up to date.

One thing you can do if you are using github pages is to create a docs folder in the project root and configure the settings to publish the page from there.