docs: add guides section with migration, FAQ, how-tos, and external resources#2741
Merged
Conversation
…esources Bring back non-API documentation from the old Jekyll site that was removed in the VitePress migration (PR #2720). Adds: - Migration guide covering breaking changes from v2 to v19 - FAQ addressing property descriptor errors - How-to articles: stub dependency, link seams, ESM stubbing, fake timers with async, TypeScript + SWC case study - External resources page with curated articles and related libraries Organised under a new 'Guides' nav section with nested sidebar, auto-generated from the guides directory structure.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2741 +/- ##
=======================================
Coverage 97.43% 97.43%
=======================================
Files 39 39
Lines 1833 1833
=======================================
Hits 1786 1786
Misses 47 47
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
- Remove dead scotch.io link (410 Gone) from external resources - Exclude reqres.in and somepage from lychee link checks (template literals inside code blocks picked up as URLs)
mroderick
marked this pull request as ready for review
July 1, 2026 06:20
fatso83
approved these changes
Jul 1, 2026
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
2 participants
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.
Brings back non-API documentation from the old Jekyll site (removed in the VitePress migration, #2720) that was never ported.
Nav: New "Guides" dropdown sits between "Getting Started" and "Concepts":
Sidebar (auto-generated from filesystem): shows the guides hierarchy when browsing under
/guides/paths.Content added
How-to articles (
/guides/how-to/)esmwithmutableNamespaceFAQ (
/guides/faq) — Property descriptor errors ("non-configurable and non-writable"), causes, and solutionsMigration guide (
/guides/migration) — Breaking changes from v2 through v19External resources (
/guides/external-resources) — Curated links to articles and related librariesInfrastructure
scripts/generate-sidebar.mjsto scan theguides/directoryHow to review locally
Then open http://localhost:5173 and look for the "Guides" nav item between "Getting Started" and "Concepts".