Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TKLDev docs suggestion #275

Open
JedMeister opened this issue Nov 8, 2014 · 1 comment

Comments

Projects
None yet
2 participants
@JedMeister
Copy link
Member

commented Nov 8, 2014

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:

  • A 'quick start' overview (with links to below for those interested) - somewhat like I wrote
  • A more 'in depth' detailed overview (like what exists but essentially matching the order of things that appears above.
  • An 'under the hood' doc that delves into how it all works

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

@l-arnold

This comment has been minimized.

Copy link

commented May 10, 2015

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.
There should be a second "Quick Reference" on how to then work with that Repository. For instance, no need to change names, take control, commit etc, once you have your repository built, particularly if all changes are taking place on Github.com. Just Kill the Directory and Clone again works quite well, particularly if you have it in your own respository tree.

In any subject, all potential extra commands should be explained in terms of how to use and what they do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.