Skip to content

Add screenshot validation script #544

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

codedbychavez
Copy link
Contributor

@codedbychavez codedbychavez commented May 19, 2025

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)

  • N/A

How to test? (only if applicable)

  • What part of the application was affected by the changes?
  1. A website/validate-document.js script was added.
  2. A website/.validationignore file was added to ignore current .mdx files in the website/docs directory.
  3. An automated workflow file was added in .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?

  1. Check if the script is works.

You can run it locally using:

node validate-document.js ./docs/integrations/segment.mdx

Requirement checklist

  • I have validated my changes on a test/local environment.
  • I have tested that the code snippets I added work. (Leave unchecked if there are no new code snippets.)
  • I have added my changes to the V1 and V2 documentations.

@codedbychavez codedbychavez requested a review from a team as a code owner May 19, 2025 18:29
Copy link

cloudflare-workers-and-pages bot commented May 21, 2025

Deploying configcat-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: b97ddf4
Status: ✅  Deploy successful!
Preview URL: https://ad579928.docs-xmy.pages.dev
Branch Preview URL: https://add-screenshot-validation.docs-xmy.pages.dev

View logs

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