Drop tutorials from jsdoc — they live natively in sitespeed.io now#2464
Merged
soulgalore merged 1 commit intomainfrom May 7, 2026
Merged
Drop tutorials from jsdoc — they live natively in sitespeed.io now#2464soulgalore merged 1 commit intomainfrom
soulgalore merged 1 commit intomainfrom
Conversation
The 14 scripting tutorials lived in jsdoc/tutorials/ and were rendered by clean-jsdoc-theme alongside the auto-generated class API docs. The sitespeed.io repo has now imported those markdown sources directly so they render with the rest of the site's docs (default layout, native TOC, syntax highlighting, copy buttons, image scaling). The jsdoc build no longer needs to ship them. What this PR does: - delete jsdoc/tutorials/ and tutorials.json - drop the "tutorials" entry from jsdoc/jsdoc.json and remove the "Tutorials" section header from the theme config - point the README's "Getting Started" links at the new sitespeed.io tutorial URLs (the old Tutorial-01-Introduction.html link was already broken — capital T did not match the lowercase filename) The class API reference (Commands, Measure, Click, …) keeps generating exactly as before, into the same path in the sitespeed.io repo. Co-authored-by: Claude Opus 4.7 (1M context) noreply@anthropic.com Change-Id: I9a5a736e126ef33386e1610d939b2df2344ef091
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The 14 scripting tutorials lived in jsdoc/tutorials/ and were rendered by clean-jsdoc-theme alongside the auto-generated class API docs. The sitespeed.io repo has now imported those markdown sources directly so they render with the rest of the site's docs (default layout, native TOC, syntax highlighting, copy buttons, image scaling). The jsdoc build no longer needs to ship them.
What this PR does:
The class API reference (Commands, Measure, Click, …) keeps generating exactly as before, into the same path in the sitespeed.io repo.
Co-authored-by: Claude Opus 4.7 (1M context) noreply@anthropic.com
Change-Id: I9a5a736e126ef33386e1610d939b2df2344ef091