Add detail to documentation #1380
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks, this seems helpful. What do you think about putting the documentation for the individual subdirectories into those subdirectories and linking to it? The top level README is already getting quite large. |
…ris_talon into cc/documentation
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
|
I agree with your suggestion and moved most of my content to subfolders. One thing I'd like to address though is that I don't understand the point of using the command within screens to show the index of your different computer screens. If I understood the purpose of that, I could give that context within the documentation too. |
|
It lets you see how Talon is numbering your screens (which should match your OS, but may be easier to access). It helps if you use voice commands to move windows between screens — e.g. "snap screen 3". Thanks! |
Mark-Phillipson
pushed a commit
to Mark-Phillipson/community
that referenced
this pull request
Mar 29, 2024
sisi-sh
added a commit
to sisi-sh/sisi_talon
that referenced
this pull request
Apr 1, 2024
* 'main' of github.com:talonhub/community: (73 commits) add lowercased firefox-esr to firefox.py (talonhub#1410) configurable number prefix without mouse grid (talonhub#1342) Update app.exe matching to work with both public and beta Talon (talonhub#1385) Add comment line to javascript (talonhub#1387) Add detail to documentation (talonhub#1380) Switch to black pre-commit mirror (talonhub#1378) Update app_name_overrides.windows.csv to use Windows Terminal instead of iTerm2 (talonhub#1379) [pre-commit.ci] pre-commit autoupdate (talonhub#1376) coalesce some list updates (talonhub#1348) Remove unused setting from c code language (talonhub#1368) mouse: adding synonyms for starting left drag. (talonhub#1356) Adds commands to focus on the last application (talonhub#1336) Stop using “brackets” to mean “braces” (talonhub#1344) Update settings descriptions (talonhub#1371) Revert changes to `user.mouse_enable_pop_click` (talonhub#1370) Fix typo in `mouse.py` variable name (talonhub#1372) Convert boolean settings to boolean (talonhub#1360) Add ruby op-or-equals command (talonhub#1347) added app name Mate-terminal (fork of Gnome-terminal) (talonhub#1367) added app name Caja (fork of Nautilus) (talonhub#1366) ...
emragins
pushed a commit
to emragins/talon-community
that referenced
this pull request
May 28, 2024
MartinRykfors
pushed a commit
to MartinRykfors/knausj_talon
that referenced
this pull request
Sep 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, the readme file describes several core features of these scripts, but a lot of the functionality is left out. This could make it difficult to get a good sense of what these scripts are capable of on first glance. Also, the current directory structure does not always make it clear where to look to discover and update certain types of commands.
Here I am providing an overview of the subdirectories within
coreandpluginfor someone to skim through and determine which folders are most likely to have the commands they're looking for. I also added a bit more detail about mouse commands and tags.