splitting Whonix documentation into a short and long edition for better usability

Website
35

Right. This thread needs to be split into a short and long edition… :wink:

Please disregard splitting Whonix documentation into a short and long edition for better usability - #10 by entr0py. That was a draft for the Quick-Start guide which I realized was way too long.

The Goal is to have 2 things when all is done.

  1. The existing documentation stays in its current form. It could use a general editing pass to remove obsolete information, merge duplicated info, etc. It should also be re-categorized into meaningful categories (instead of having half the entries in “Advanced Topics”). Proposed categories.

  2. Quick-Start guide. Proposed outline.

@torjunkie’s guide falls into a category of its own. The issue with a document that is that comprehensive is that it becomes difficult to maintain over time because you forget what’s in it. Hence, keeping it disaggregated like the current wiki makes more sense IMO. However, it seems like it would be a waste not to offer it somewhere…

Since @torjunkie is busy at the moment, I will take pieces of his guide and put together a Quick-Start draft. Hopefully, he’ll have time to review it with his excellent writing skills! Also, I don’t know how to make web pages, so once the content is finished, perhaps @Ego can port it to the web platform.

EDIT: Speaking of the web platform, does the current engine allow for collapsible text without javascript? It’d be nice to direct readers to additional links for further information, but only if they can be hidden behind a click.

1 Like