christian.staudt at kit.edu
Wed Jun 17 15:49:49 CEST 2015
Hi NetworKit developers,
I’m a bit worried about our website. There’s almost always something that is out of date (e.g. https://networkit.iti.kit.edu/features/) and may put people off. How can we keep the effort low that goes into writing and updating online documentation, yet keep it up-to-date and helpful?
Look at projects that have nice websites, like:
I think a common pattern is that the project website is automatically generated from the repository and code base with Sphinx. I think we should move towards that. Also I wouldn't shed a tear for the current page design if it went away.
Another nice thing would be to have every documentation page that contains code in a form that is runnable and testable. Maybe Jupyter Notebooks can help.
-------------- next part --------------
A non-text attachment was scrubbed...
Size: 495 bytes
Desc: Message signed with OpenPGP using GPGMail
More information about the NetworKit