Add screenshot validation script #544
Open
+385
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying configcat-docs with
|
| Latest commit: |
0d72390
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://31e8b16c.docs-xmy.pages.dev |
| Branch Preview URL: | https://add-screenshot-validation.docs-xmy.pages.dev |
adams85
requested changes
May 26, 2025
Comment on lines
+99
to
+101
| checkImageNameConvention(imageSrc, errors); | ||
|
|
||
| } |
There was a problem hiding this comment.
The most important step, i.e. checking image dimensions, is missing here.
Please add it - of course, without the cover image-related parts (as there are no cover images in the docs).
adams85
requested changes
May 26, 2025
Co-authored-by: adams85 <[email protected]>
… into add-screenshot-validation
Co-authored-by: adams85 <[email protected]>
Co-authored-by: adams85 <[email protected]>
Co-authored-by: adams85 <[email protected]>
adams85
reviewed
May 29, 2025
| # articles, we don't enforce every rule. However, when an article is updated, | ||
| # DO NOT ADD NEW ENTRIES TO THIS FILE. New documents should be created | ||
| # according to the guidelines outlined in https://github.com/configcat-labs/content-wiki/blob/main/screenshot-guide.md. For older | ||
| # documents, we don't enforce every rule. However, when an document is updated, |
There was a problem hiding this comment.
Suggested change
| # documents, we don't enforce every rule. However, when an document is updated, | |
| # documents, we don't enforce every rule. However, when a document is updated, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.jsscript was added.website/.validationignorefile was added to ignore current.mdxfiles in thewebsite/docsdirectory..github/workflows/validate-document.ymlthat would run each time a PR is created that contains new or modified.mdxfiles.What should be tested?
You can run it locally using:
Requirement checklist