[Cryptech Core] [Cryptech Tech] Doc, Markdown, and Wiki

Randy Bush randy at psg.com
Mon Oct 27 20:40:41 UTC 2014


my personal preference is the wiki.  but i think that how the docs are
organized is more important than the format.  the format should
facilitate the organizaion, hence my liking a wiki.

for 'internal,' i.e. code contributor use, organizing by module makes
sense.

but the front pages really need to be from the user pov.  how to build
and test on novena, step by boring step.  how to build and test on
terasic, step by step.  how the code and docs are organized to design
and build your own.  ...

rob and i have been weak on this user view with the routing sec project.
things grew from the source out and up, not leading to an easy to use
docco set.

and you have seen rob and me beat our heads on the current wiki.  and i
am not sure you, joachim, have a happy novena yet.

i guess my point is that one face of the wiki has to maximize the user's
chances of easy success.  at the same time i agree that the code and
hardware need solid docs.

randy



More information about the Core mailing list