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

Discussion thread: what do we include in the “Getting Started” page? #45

Open
tararoys opened this issue Aug 13, 2020 · 2 comments
Open

Comments

@tararoys
Copy link
Contributor

This is the issue for discussing what to include on the Getting Started page.

TLDR: getting started should include everything necessary to get a basic working installation of Talon on all three operating systems such that when you say 'help alphabet' the alphabet appears

A set of basic commands

Lots of links to other pages where appropriate, such as links to tutorials, links to more advanced installation guides, links to troubleshooting, etc.

Now feel free to make proposals about what 'everything necessary' means, what basic commands should be included, and other things to nail down what ought to be in Getting Started.

@gimpf
Copy link
Contributor

gimpf commented Aug 13, 2020

Well, I recently added the command history and the help system, and I think those two should definitely stay. Learning how to read the help is almost always well-spent time.

Everything else already depends on the preferred style:

  1. Start with purpose made commands for any single thing you can do (the current approach).
  2. Start with teaching the alphabet and key-chords (that was my approach).

I don't know what is more popular. It's legitimate to want to start either way. Given how fast knausj develops, approach 1 might be good enough for the first few weeks, especially when used w/eye-tracking.

However, because of my choices, I don't really know what first commands are really useful -- I still use almost none of those. Keychords all the way!

As a datapoint, the famous intro at whalequench https://whalequench.club/blog/2019/09/03/learning-to-speak-code.html is de facto approach 2.

@gimpf
Copy link
Contributor

gimpf commented Aug 19, 2020

anyone there?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants