Reorganize list of breaks#89
Open
kfranqueiro wants to merge 42 commits intoaccessiblecommunity:mainfrom
Open
Conversation
kfranqueiro
force-pushed
the
kgf-ac-index
branch
2 times, most recently
from
f0f6cd0 to
7246066
Compare
(These are instances that had site-section-level discussion items)
Also declare discussionItems as non-empty
(This includes referencing WCAG 3 requirements instead of guidelines)
(This is undoing a mistake I added earlier)
This also simplifies to no longer allow arranging by SC/requirement, to avoid the code becoming even more complex than it already was. Filtering by SC/requirement seemed more apt in practice.
kfranqueiro
force-pushed
the
kgf-ac-index
branch
from
852b0f8 to
2d2dc91
Compare
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
1 participant
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.
This PR reorganizes both the reading and writing experience for the list of breaks, using an Astro collection with custom loading logic.
Reading experience
The top-level index page now contains a form with the following controls:
Writing experience
Breaks are now documented in the same file as the code (or prose) responsible for them, using a custom
@breakJSDoc tag or thebreaksproperty in Markdown files.The README has been updated to document how this works, and also to document the
FixableandFixableRegioncomponents for implementing broken and fixed versions.Note that documented breaks are not directly bound to particular components (and we don't yet have a way to implement broken vs. fixed prose in Markdown), but this potentially opens the door to doing so if we were to associate IDs with each.