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

Add errata to w3c/wcag repo and cross-reference from informative docs #4170

Merged
merged 17 commits into from
Jan 15, 2025

Conversation

kfranqueiro
Copy link
Contributor

This adds the following:

  • Imports the 2.1 and 2.2 errata pages into this repo
    • Reorganizes existing 2.1 errata in reverse-chronological order
    • Adds date stamps for all existing errata I could trace back to a commit
    • Makes use of variables and Liquid expressions to minimize potential for copy-paste errors between sections
    • Auto-generates table of contents within CustomLiquid.ts to avoid desync when adding versions
    • Documents patterns/formats for authoring errata in errata/README.md (with mention in top-level README)
  • Adds logic to parse information from errata pages and include relevant errata within Guideline/SC boxes and term definitions within informative docs pages
    • Errata are only included when building for a specific version (i.e. not the editor's draft, in which case corrections are expected to already be inlined)
    • Only errata against the latest published version are included in informative docs
  • Updates publish-w3c script to also copy relevant errata file for version being published
  • Adds links to errata pages in top-level index used for dev server and PR builds

Examples of how errata appear:

For a success criterion (as an additional subheading):
Errata inserted at the bottom of a SC box

For a key term definition (as an additional paragraph + list):
Errata inserted at the bottom of a key terms definition

@kfranqueiro kfranqueiro requested a review from iadawn December 11, 2024 22:42
@w3cbot
Copy link

w3cbot commented Dec 11, 2024

kfranqueiro marked as non substantive for IPR from ash-nazg.

Copy link

netlify bot commented Dec 11, 2024

Deploy Preview for wcag2 ready!

Name Link
🔨 Latest commit 6596291
🔍 Latest deploy log https://app.netlify.com/sites/wcag2/deploys/6788005bda4a2000082de9e5
😎 Deploy Preview https://deploy-preview-4170--wcag2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kfranqueiro kfranqueiro merged commit 05fd019 into w3c:main Jan 15, 2025
5 checks passed
@kfranqueiro kfranqueiro deleted the kgf-errata branch January 15, 2025 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants