On Mon, 2007-05-14 at 21:52 +0200, Dirk Nehring wrote: > The handbook was in trac before, until the team decided not to maintain > 2 dokus in parallel. So, wbx copied everythin to the handbook and > deleted dopple information from trac. A system to generate a doc > directly out of a wiki would be more useful in my eyes, never seen such > a system. The layout quality of the handbook can also be optimized. But: > a handbook is professional.
I have quite some wishes or ideas for a handbook and the wiki in general, but i don't know yet how far this is doable. - Keep the handbook style for the whole "official" documentation, but maintain it in the wiki. The handbook style makes it more professional indeed. - I want a exported pdf/plaintext version of the "handbook"-wiki pages. E.g. for offline reading. - To include some page (or maybe even only some paragraph of the page) to the handbook, you just add it to some special index page, based on this index the files get generated. - Different version of the pages for different releases without much hassle. We tag everything with the release it belongs to. So currently the default is to display the 1.0 matching pages. To document an upcoming release, one just takes the existing page, changes it appropriately and sets a new release-tag. This new page version does not replace the old one, but lives in parallel (like branching it). With the new stable release 1.1, the 1.1-tagged pages are the new default. To view the old ones or the ones for the upcoming release, one just has to tick it somewhere. The handbook-generation honours the tags, too, of course, and makes different files for the different release-tags. > For every new information a developer has to decide if you have to put > it on the website or into the handbook. Does this fit into you concept? As we want _structured_ information, you will have to think about the way your information integrates into the existing one for sure. If one is unsure about it, he can just add it as a new page to the wiki and start discussing about the inclusion to the handbook. I clearly don't want a wiki that is just some information dump... Please extend/change this list of ideas. A good plan is half the implementation ;) Bye, Lothar _______________________________________________ freewrt-developers mailing list [email protected] https://www.freewrt.org/lists/listinfo/freewrt-developers
