-
Notifications
You must be signed in to change notification settings - Fork 33
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 audits in the Jupyter ecosystem #133
Conversation
is there anyway to include other audits that have been done? it seems diminishing of other's efforts to no include them. at the very least, i think it would be working mentioning: |
I'm going to add them in follow up PRs, please see #125 I want to stick with one audit per PR for it to be easier to review |
thanks for sharing such a thorough roadmap. those improvements look great! |
Edit: I pushed the changes for all the audits, so now this PR will add documentation for all the accessibility audits |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My opinion is that the audits page should mostly just link out to content elsewhere, rather than adding / duplicating content to the docs.
@@ -0,0 +1,24 @@ | |||
# Jupyter Accessibility Audits |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I were someone coming to this page for the first time, I might wonder why some of the audits are in GitHub issues, while two are in these docs. Is there some way we can address that? Or maybe put all the audit links in one list, rather than splitting them into two lists?
I'm not sure what the best approach is, but currently this looks confusing to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree - the current structure (two lists, some with in-depth content other without) make this confusing at the least, and signals some sort of "hierarchy" / "importance at worst"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should I only add the links to the github issues/PR?
Still we need to add the new two pages to a toctree, if not Sphinx will not include them and will not be reachable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Edit: I removed the single audit pages and just left the list of all the audits
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR needs some restructuring, as discussed separately the main content is in the issues themselves, these docs should point to those, avoid repeating content and if needed provide only essential context.
@@ -0,0 +1,24 @@ | |||
# Jupyter Accessibility Audits |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree - the current structure (two lists, some with in-depth content other without) make this confusing at the least, and signals some sort of "hierarchy" / "importance at worst"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm really happy to see these collected somewhere. Thank you for making this a priority! And thank you for the descriptive link text. I love that the dates are made clear.
This looks good to me, and it previews well. I'd like to merge it, but GitHub is telling me there are changes still requested. It looks like the changes have been made but not rereviewed after, so I'll check back and see if I can merge.
This PR,
This PR is part of #125
📚 Documentation preview 📚: https://jupyter-accessibility--133.org.readthedocs.build/en/133/