-
Notifications
You must be signed in to change notification settings - Fork 589
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
Advanced docs validation script #2075
Open
NWylynko
wants to merge
77
commits into
main
Choose a base branch
from
nick/advanced-docs-validation-script
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
+5,005
−1,167
Conversation
This file contains 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
…<SignIn /> component regardless of if they have an example
…ectPage /> component
jescalan
approved these changes
Mar 11, 2025
package.json
Outdated
}, | ||
"devDependencies": { | ||
"@sindresorhus/slugify": "^2.2.1", | ||
"@types/node": "^22.13.2", | ||
"chokidar": "^4.0.3", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔪
Comment on lines
+28
to
+50
const VALID_SDKS = [ | ||
'nextjs', | ||
'react', | ||
'javascript-frontend', | ||
'chrome-extension', | ||
'expo', | ||
'ios', | ||
'nodejs', | ||
'expressjs', | ||
'fastify', | ||
'react-router', | ||
'remix', | ||
'tanstack-start', | ||
'go', | ||
'astro', | ||
'nuxt', | ||
'vue', | ||
'ruby', | ||
'python', | ||
'javascript-backend', | ||
'sdk-development', | ||
'community-sdk', | ||
] as const |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
const VALID_SDKS = [ | |
'nextjs', | |
'react', | |
'javascript-frontend', | |
'chrome-extension', | |
'expo', | |
'ios', | |
'nodejs', | |
'expressjs', | |
'fastify', | |
'react-router', | |
'remix', | |
'tanstack-start', | |
'go', | |
'astro', | |
'nuxt', | |
'vue', | |
'ruby', | |
'python', | |
'javascript-backend', | |
'sdk-development', | |
'community-sdk', | |
] as const | |
const VALID_SDKS = [ | |
'nextjs', | |
'react', | |
'js-frontend', | |
'chrome-extension', | |
'expo', | |
'ios', | |
'nodejs', | |
'expressjs', | |
'fastify', | |
'react-router', | |
'remix', | |
'tanstack-start', | |
'go', | |
'astro', | |
'nuxt', | |
'vue', | |
'ruby', | |
'python', | |
'js-backend', | |
'sdk-development', | |
'community-sdk', | |
] as const |
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.
This is a cut down version of #2041 doing purely the validation aspect. It covers the following things:
Standard docs validation
<Include />
components exist<Include />
src props start with "_partials/"New SDK Validation
<If />
components reference valid SDKs for the guide<If />
components reference SDKs available in manifest