Join GitHub today
TKLDev docs suggestion #275
Following a bit of an experiment in documenting for TKLDev (I created something of a 'quick start' to using TKLDev that was trying to also be newb friendly - see here). The feedback so far has been positive (although in fairness only 2 people have provided feedback so far).
Ken in this thread has given what I think is a brilliant suggestion! Essentially 3 docs:
Make it clear on the "Manual Setup" that that is for NON-TKL usage (or at least so in my opinion).
Make Clear how to use various Versions within TKL. (Version Tags?) How to operate them.
In general Docs should follow Macro to Micro Path. Ie, quick Start, table of Contents, Detailed Setup, then Granular information.
In the Quick Start, the one path is cloning a Repository.
In any subject, all potential extra commands should be explained in terms of how to use and what they do.