-
-
Notifications
You must be signed in to change notification settings - Fork 14.9k
Tracking Issue for a Chapter on Accessibility in Rustdoc #151007
Copy link
Copy link
Open
Labels
A-a11yArea: Anything to do with accessibilityArea: Anything to do with accessibilityA-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCCategory: An issue tracking the progress of sth. like the implementation of an RFCT-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Metadata
Metadata
Assignees
Labels
A-a11yArea: Anything to do with accessibilityArea: Anything to do with accessibilityA-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCCategory: An issue tracking the progress of sth. like the implementation of an RFCT-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Type
Fields
Give feedbackNo fields configured for issues without a type.
This is a tracking issue for writing a chapter about accessibility in rustdoc. The chapter is meant to describe the accessibility of rustdoc, that is, the accessibility guidelines it follows, and its compliance with recognised norms like the WCAG 2.1 Guidelines. It was discussed in #t-rustdoc > A Proposal to Make Rustdoc More Accessible.
About tracking issues
Tracking issues are used to record the overall progress of implementation.
They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions.
A tracking issue is however not meant for large scale discussion, questions, or bug reports about a feature.
Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.
Discussion comments will get marked as off-topic or deleted.
Repeated discussions on the tracking issue may lead to the tracking issue getting locked.
Steps
rustdocUnresolved Questions
N/A (if you have any please send them down below or in the zulip thread)
Implementation Details:
An excerpt from the thread about the documentation: