Update downloading-community.md for clarity pt 1 - #464
Conversation
Clarified the explanation of downloading the Talon community user file set and the options available for customization.
✅ Deploy Preview for talon-wiki-refactor ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
for more information, see https://pre-commit.ci
| After installing Talon and a speech recognition engine, you will need to download a user file set. A user file set allows you to customize the files, documents, and settings for your personal use. | ||
|
|
||
| This can be done using two different methods, zip and Git. | ||
| There are two file options for downloading the user file set: a ZIP file and a Git. |
There was a problem hiding this comment.
As a clarification, Git is a program, so I would not put the word a before Git.
There was a problem hiding this comment.
Okay, agreed. So we probably wouldn't describe it as a "file option" either.
| - The community will update the user file set with bug fixes and new features, and you will want | ||
| to update your local copy of it. | ||
| - You might make your own changes to some of these files. | ||
| Possible updates you could make include: |
There was a problem hiding this comment.
What this section was originally trying to explain is that Git is useful for managing conflicts between your own personal changes and updates. It basically prevents you from having to re-download Community every time you want an update and then having to redo all of your personal changes manually. Git will allow automatically merging changes that do not conflict with each other, which is highly convenient. It also makes it easier to merge conflicting changes together.
The choice is basically between (1) downloading a zip file, which is easier in the short term and does not require learning Git and (2) using Git to make merging your personal changes with updates easier in the long run.
Do you think you understand what this page was trying to convey or do you have questions?
There was a problem hiding this comment.
Yes, I think I understood the gist, but perhaps not all of the details. I'm revising the following sections that discuss ZIP vs. Git now, which discuss the short and long term advantages.
| # Downloading the Talon Community User File Set | ||
|
|
||
| After installing Talon and a speech recognition engine, as described here you will need to download a user file set. This wiki discusses the Talon community user file set, so this page discusses downloading that specific user file set. | ||
| After installing Talon and a speech recognition engine, you will need to download a user file set. A user file set allows you to customize the files, documents, and settings for your personal use. |
There was a problem hiding this comment.
This page really did not make it clear in the first place that the reason for downloading a user file set is that Talon does not come with builtin commands. If you want voice commands, you have to download a file set or write them yourself. The reason why you need to download a file set for Talon does not have to do with customization, though you can customize them.
There was a problem hiding this comment.
Yes, that was only partially clear to me. I understood that Talon is customizable, but I wasn't sure in what ways. Perhaps providing an example like the voice commands would help. Also, a better definition of file set might help. I just pulled a basic one from the web.
| - You might make your own changes to some of these files. | ||
| Possible updates you could make include: | ||
|
|
||
| - Updates the community makes to the user file set to fix bugs and to add new features. |
There was a problem hiding this comment.
What do you think of changing this sentence to say "Downloading updates to the Community user file set to fix bugs and to add new features"? and changing the next sentence to "Making your own changes to these files."?
2 participants
Clarified the explanation of downloading the Talon community user file set and the options available for customization.