-
Notifications
You must be signed in to change notification settings - Fork 99
Add a linter that Tutorials index page includes all tutorials #2830
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
Comments
Hi @Eric-Arellano, I’d like to take this on! I’ll work on adding a linter to ensure all tutorials in tutorials/ appear in both sections of index.mdx, with URL matching and possibly title checks. |
Hey Gyan, thanks! We still need to add a little more information to this for how exactly it will work. I'll coordinate with Frank if we think this would be a good issue to work on, along with adding more instructions. |
Sure, thankyou for the clarification. |
Hi @Gyan-max, I've added a script to check the links in #2978, however, it doesn't check titles. Once #2978 is merged, it would be great if you could adapt the script to also check titles. I recommend you:
|
Sure, let #2978 be merged, then i'll adapt the script and modify it to check for title |
The Tutorials index page is going to list all tutorials twice:
We need to ensure that every file in
tutorials/
shows up exactly once in both sections intutorials/index.mdx
.This check will be similar to
checkPatternsIndex.ts
, but I think their implementation diverges enough that it's going to be clearer to create a dedicated check.At a minimum, verify the URL is identical. If it isn't too hard, also verify the title is the same (relates to #2489).
Ensure this check is added to CI and the
./check
script.The text was updated successfully, but these errors were encountered: