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

WIP - Add Notebook Authoring Guide #127

Closed
wants to merge 2 commits into from

Conversation

steff456
Copy link
Contributor

@steff456 steff456 commented May 17, 2023

This PR,

  • Creates a documentation page with the notebook authoring guide
  • Links the new page for adding it to the side menu

This PR is part of #125


📚 Documentation preview 📚: https://jupyter-accessibility--127.org.readthedocs.build/en/127/

@trallard trallard added type: enhancement 💅🏼 New feature or request area: documentation 📖 Accessible user documentation PR: needs review 👀 This PR is completed and someone needs to have a look labels May 17, 2023
Copy link
Contributor

@isabela-pf isabela-pf left a comment

Choose a reason for hiding this comment

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

This seems accurate and comprehensive to me! Thank you for reading through the recommendations and working to make them fit here.

I've been staring at this trying to give a good review and I'm not confident in all these comments. I feel like there may be another way to structure some of this, but I will have to keep thinking on it. I do like that this structure allows readers to jump to parts that may be relevant to them (ie. only reading the Visualizations section or the like).

I'm also considering whether or not a short list might be helpful. As usual, I'm open to feedback on all that. Thank you so much for taking a stab at these dense documents and making something new from them!

docs/resources/notebook-authoring-guide.md Outdated Show resolved Hide resolved

All the information presented is based on the [draft authoring tips](https://github.com/Iota-School/notebooks-for-all/blob/main/resources/event-hackathon/accessibility-tips-for-jupyter-notebooks.md) and the [Notebook authoring accessibility checklist](https://github.com/Iota-School/notebooks-for-all/blob/main/resources/event-hackathon/notebook-authoring-checklist.md) from the Notebooks For All team.

# Table of contents
Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you for keeping this! I'm noticing it's gummed up in some sources on the original documents, so I'm grateful you took the time to add it properly here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it is important to point where all the original information is

docs/resources/notebook-authoring-guide.md Show resolved Hide resolved
docs/resources/notebook-authoring-guide.md Outdated Show resolved Hide resolved
docs/resources/notebook-authoring-guide.md Outdated Show resolved Hide resolved
docs/resources/notebook-authoring-guide.md Outdated Show resolved Hide resolved
@trallard trallard changed the title Add Notebook Authoring Guide WIP - Add Notebook Authoring Guide May 25, 2023
Co-authored-by: Isabela Presedo-Floyd <50221806+isabela-pf@users.noreply.github.com>
@trallard
Copy link
Member

trallard commented Jan 9, 2024

Closing this for now as we plan the format/path forward

@trallard trallard closed this Jan 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 Accessible user documentation status: on hold ⛔️ This item is blocked by another action type: enhancement 💅🏼 New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants