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

Update documentation/process to clarify when HTML validation takes place #282

Open
thomasheritage opened this issue Sep 16, 2024 · 0 comments

Comments

@thomasheritage
Copy link
Collaborator

It wasn't clear to me upfront that a document could fail validation even if all issues:

  • shown in the browser (in the floating red box)
  • given by the validate.mjs script (e.g. installed as a git commit hook)

were resolved.

Additional validation takes place before (and after) the document has been rendered (mainly using html5validator I believe).

It might be helpful to warn the user of this and/or perhaps html5validator could be included as part of validate.mjs (although some practical guidance would be needed on dependencies -- at the minimum Python and Java are needed in addition to Node I think).

Or perhaps the GitHub Actions job (called "build") could be adjusted to make it clearer when a failure is due to the (extra) HTML validation failing (by separating that out as a named step in the Workflow maybe).

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

No branches or pull requests

1 participant