search

jupyter / accessibility

A repository for ongoing work around making Jupyter's software accessible and inclusive
https://jupyter-accessibility.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
66 stars 33 forks source link

Add page about accessibility docs #123

Closed gabalafou closed 1 year ago

gabalafou commented 1 year ago

This PR addresses the problem that if you search the web for Jupyter-related accessibility docs, you are highly likely to end up at this repo because it tends to be in the top few results (at least whenever I search across various search engines). But this repo serves as the team compass for Jupyter Accessibility, not as a repo for end-user accessibility docs.

So this PR adds a page about the current state of accessibility docs and puts links to this new page in four highly visible places:

  1. At the top of this repo's README
  2. At the top of this repo's ReadTheDocs home page
  3. At the top of the ReadTheDocs table of contents sidebar
  4. At the top of the "Useful resources" page in the ReadTheDocs site

:books: Documentation preview :books:: https://jupyter-accessibility--123.org.readthedocs.build/en/123/

gabalafou commented 1 year ago

More needs to be done, but this is a start.

gabalafou commented 1 year ago

@steff456 (I don't know how to add you as a reviewer)

gabalafou commented 1 year ago

I think the links check is failing because I put the following URL in the repo readme:

https://jupyter-accessibility.readthedocs.io/en/latest/accessibility-docs

which doesn't exist until this PR is merged and triggers a ReadTheDocs deploy.

But there are some other failures or warnings in the log that I'm not sure about.