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

Merged
merged 11 commits into from
Apr 4, 2025
Merged

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, explainer, and requirements
    • Subsequently runs these through spec-generator
    • Reuses the existing build to produce the howto directory in the output folder
    • Note: The action is now structured such that GitHub Pages should be configured to use GitHub Actions as its source, rather than a branch (so it doesn't need to consume extra space when cloning the repository)

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 canceled.

Name Link
🔨 Latest commit 6558c12
🔍 Latest deploy log https://app.netlify.com/sites/wcag3-howtos/deploys/67efe01311e4ad00080ab1ae

Copy link

netlify bot commented Mar 20, 2025

Deploy Preview for wcag3 ready!

Name Link
🔨 Latest commit 6558c12
🔍 Latest deploy log https://app.netlify.com/sites/wcag3/deploys/67efe013761fb100082924ef
😎 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.

@kfranqueiro kfranqueiro force-pushed the kgf-astro branch 4 times, most recently from e07cbc4 to c7e1ca7 Compare April 1, 2025 17:10
@iadawn iadawn self-requested a review April 3, 2025 18:12
@kfranqueiro kfranqueiro merged commit f806158 into w3c:main Apr 4, 2025
9 checks passed
@kfranqueiro kfranqueiro deleted the kgf-astro branch April 4, 2025 13:46
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.

2 participants