DEV Community

Discussion on: What makes maintaining documentation difficult?

Collapse
 
dmfay profile image
Dian Fay

Like @einenlum I also have written an article about how I manage docs for my open source project.

I prefer to keep the documentation colocated; this ensures that the documentation is correct for any given commit, and makes deploying it much easier. I don't know if another static site generator will be able to overcome the home team advantage of GitHub Pages, for all Jekyll wouldn't be my first choice of framework.