4 ms·

For me the biggest problem with documentation has been keeping it up to date, aka "Documentation is a future lie". This seems to produce nice looking documentat

For me the biggest problem with documentation has been keeping it up to date, aka "Documentation is a future lie". This seems to produce nice looking documentation but puts updating it in a separate workflow from changes in the code. Will it do anything to help people make sure that the contents stay relevant?

jakeprins 6y ago
Thats a valid point! I'm actually still validating the MVP version and I have a lot of ideas on how to improve. I'm think about adding a feature to connect your github repo with SidePage and adding a "changelog" feature where you docs on SidePage also show your latest changelog entries. Still need to work this out. Also would be cool if you could just import your poject and generate some pages from the project's readme, but again I haven't worked out the details yet. I will investigate this further to see what options are available to improve the workflow of updating docs.