3 ms·
I never understood why nobody has built a documentation webapp where you just enter the SVN/CVS/GIT of a project and the webapp checks out the code onto the ser
by edb 18y ago
I never understood why nobody has built a documentation webapp where you just enter the SVN/CVS/GIT of a project and the webapp checks out the code onto the server's backend at a fixed internval then generates documentation from a standardized commenting layout, kind of like doxygen but more social.
It could be neat, you could even have the app merge user submitted comments or changes to documentation (submitted via the web-app) back into the code documentation in the repository. Maybe set a convention where you create a DocApp folder for pages, all synced with the online webapp.
I hope this is what Nodata is working towards.
- jamesbritt 18y agoIt's been on my To-Do list for ruby-doc.org for, oh, forever. One issue is in making sure that as the API changes you can still correctly associate past comments to API where still appropriate. (The auto-svn c/o is in place at least ...) Not a fan of automatically merging comments back into the source code though. Better to just have someone sensible update the docs when needed and submit a patch.