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

Re-architect Guidelines using Astro #296

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

kfranqueiro
Copy link
Contributor

@kfranqueiro kfranqueiro commented Mar 20, 2025

This splits the guidelines into individual files for the following:

  • Acknowledgements
  • Groups
  • Guidelines
  • Requirements/assertions
  • Glossary terms

These are then reassembled and built into guidelines/index.html by Astro.

Markdown is used for prose, and extensions are implemented to make common tasks more convenient (e.g. decision trees, editor's notes, definition links).

Included in this PR

  • Top-level guidelines folder containing groups, guidelines, requirements/assertions, terms, and acknowledgements, each split to separate files
  • README documentation on commands, directory structure, data formats, and Markdown extensions
  • Updated github action, which:
    • Runs the new build for guidelines/index.html
      • This build also retains the explainer and requirements documents in-place
    • Runs guidelines/index.html through spec-generator
    • Reuses the existing build to produce the howto directory in the output folder

This PR also already incorporates the changes of the following open PRs:

Copy link

netlify bot commented Mar 20, 2025

Deploy Preview for wcag3-howtos ready!

Name Link
🔨 Latest commit 1582a1b
🔍 Latest deploy log https://app.netlify.com/sites/wcag3-howtos/deploys/67dc6698ad8ae40008c8cd7a
😎 Deploy Preview https://deploy-preview-296--wcag3-howtos.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.

Copy link

netlify bot commented Mar 20, 2025

Deploy Preview for wcag3 ready!

Name Link
🔨 Latest commit 1582a1b
🔍 Latest deploy log https://app.netlify.com/sites/wcag3/deploys/67dc66987349bc0007146ed0
😎 Deploy Preview https://deploy-preview-296--wcag3.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.

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.

1 participant