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

Add a page about visual impairments to the docs #2258

Merged
merged 5 commits into from
Mar 18, 2024

Conversation

C-Loftus
Copy link
Contributor

@C-Loftus C-Loftus commented Mar 1, 2024

Fixes #935

I specifically addressed everything in that issue. If desired, I could reference my sight free repository or any of the discussions Pokey and I had with Parham. I wasn't entirely sure since on one hand what I wrote up doesn't discuss anything about blindness or visual impairments that affect the ability to see the hats regardless of size, but on the other hand that is relatively specific and would require referencing another package outside the repository which I don't want to cause issues.

I continue to be interested generally about ways to make cursorless better for non-visual use but realistically this might be more of a stretch goal and not for this PR

Checklist

(First take in checklist not relevant since no code is changed)

@C-Loftus C-Loftus changed the title Adds a page about visual impairments to the docs (re: 935) Add a page about visual impairments to the docs Mar 7, 2024
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.

Thanks for this! I pushed some tweaks. We're trying to apply the diataxis principles. I view this page as sitting in the how-to guide quadrant, so I reworked it to feel more like a how-to guide. Lmk what you think

@pokey pokey linked an issue Mar 14, 2024 that may be closed by this pull request
@C-Loftus
Copy link
Contributor Author

Thanks for this! I pushed some tweaks. We're trying to apply the diataxis principles. I view this page as sitting in the how-to guide quadrant, so I reworked it to feel more like a how-to guide. Lmk what you think

For sure, that makes sense thanks for clarifying. I will make sure to keep this style guide in mind if/when I make additional documentation contributions. Feel free to ping me going forward if you have any ideas/follow ups for visual impairment features/docs, among other things.

@C-Loftus
Copy link
Contributor Author

C-Loftus commented Mar 17, 2024

Updated by running merging branch 'main' into main. Verbally aligned in Cursorless meetup that this looks good to me. Should be good to merge assuming CI is not having issues.

@pokey pokey enabled auto-merge March 18, 2024 11:32
@pokey pokey added this pull request to the merge queue Mar 18, 2024
Merged via the queue into cursorless-dev:main with commit 0b5cdee Mar 18, 2024
14 checks passed
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

Successfully merging this pull request may close these issues.

Add page about visual impairments to the docs
2 participants