Add screenshot validation script #544
Open
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.
Describe the purpose of your pull request
Add screenshot validation script to the docs. This script ensures that screenshots in new and updated documents comply with the screenshot guide.
Related issues (only if applicable)
How to test? (only if applicable)
website/validate-document.js
script was added.website/.validationignore
file was added to ignore current.mdx
files in thewebsite/docs
directory..github/workflows/validate-document.yml
that would run each time a PR is created that contains new or modified.mdx
files.What should be tested?
You can run it locally using:
Requirement checklist