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

minor contributing docs #1866

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

saidelike
Copy link
Collaborator

Checklist

@saidelike
Copy link
Collaborator Author

done again due to messing up in #1857

@auscompgeek auscompgeek added the documentation Improvements or additions to documentation label Sep 9, 2023
Copy link
Member

@pokey pokey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good with minor comment!

@@ -45,22 +45,22 @@ extension](#running--testing-extension-locally). You may also find the [VSCode A

where `some.extension` is the id of the extension you'd like to install into the sandbox

6. Copy / symlink `cursorless-talon-dev` into your Talon user directory for some useful voice commands for developing Cursorless.
6. Copy / symlink [`cursorless-talon-dev`](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We generally use relative links when they're inside the repo

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also prefer relative links. but when I look through the code base we haven't really been too rigorous about that unfortunately.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can believe that, but I don't that's an argument against changing this to a relative link, no?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope

@@ -45,22 +45,22 @@ extension](#running--testing-extension-locally). You may also find the [VSCode A

where `some.extension` is the id of the extension you'd like to install into the sandbox

6. Copy / symlink `cursorless-talon-dev` into your Talon user directory for some useful voice commands for developing Cursorless.
6. Copy / symlink [`cursorless-talon-dev`](cursorless/cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link looks wrong, no?

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

Successfully merging this pull request may close these issues.

None yet

4 participants