Repository navigation
Revise accessibility document for clarity and detail - #76
Merged
Merged
Conversation
Updated accessibility documentation to clarify goals, contributor expectations, and reporting processes. Signed-off-by: IGL - Identity Governed Logic <244852114+cosudm@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documented workarounds overstate access to CLI demo results and alternative site content.
1 open issue
What changed in this PR
This PR expands accessibility guidance for IGL’s user-facing interfaces and documentation.
Changes:
- Defines accessibility goals and contributor expectations.
- Documents reporting, triage, ownership, and maintenance.
- Describes supported environments and known limitations.
| File | Description |
|---|---|
| ACCESSIBILITY.md | Adds accessibility goals, reporting procedures, responsibilities, and limitations. |
Review effort: Balanced
| - **The generated API reference is produced by a script** (`platform/site/gen_reference.py`). Its heading structure and link text follow the OpenAPI document and have not been audited for screen reader navigation. | ||
| - **Documentation in `docs/` uses tables and code blocks heavily.** These are readable, but long tables may be hard to navigate in some screen readers. There is no alternative presentation at present. | ||
|
|
||
| Where a limitation above is tracked as an issue, it will be linked from this list. Workarounds: the same information shown in IGL Studio and the demo is available as plain JSON through the HTTP API, and every page of the site is also described in `platform/site/llms.txt` as plain text. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated accessibility documentation to clarify goals, contributor expectations, and reporting processes.
What
Closes #
Why
How it was verified
npm testpasses locallyspec/openapi.yamlchanged:npx --yes @redocly/cli@1 lint spec/openapi.yamlpasses, version bumped,spec/README.mdandCHANGELOG.mdupdatedCHANGELOG.mdupdated under Unreleasedgit commit -s)