Add tutorials overview and TOC #2978
Open
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
frankharkins
commented
Apr 11, 2025
There was a problem hiding this comment.
To keep it simple, I decided not to parse into a markdown AST because this script is specific to this page and we can expect a certain structure. Here's an example of it catching both types of error:
frankharkins
force-pushed
the
FH/tutorials-navigation
branch
from
e59a8a6 to
82c3099
Compare
We're not adding hello world in this first iteration
…H/tutorials-navigation
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Apr 15, 2025
#2965 added support to spellcheck TOCs, but this has the side-effect of also checking URLs. Unfortunately, there are some words that are valid in a URL but shouldn't be added to the dictionary as they're not valid elsewhere. One example of this is `grovers`; usually this should be corrected to `Grover's`, but it _is_ valid in a URL. Since we can't add file-level ignores in the `_toc.json`, I think the best approach is to ignore these URLs using a regex. This is not a problem on `main`, but it's blocking CI in #2978.
…H/tutorials-navigation
frankharkins
commented
Apr 15, 2025
|
|
||
| ## Browse tutorials by tool | ||
|
|
||
| Simple text to explain this tools-based schema |
|
|
||
| ## Browse tutorials by topic | ||
|
|
||
| Simple text to explain this tools-based schema |
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.
Also adds a script to check the page is valid.