fix(pages): structure#16
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Member
Author
|
Merging as a hot fix |
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds and reorganizes learning resources across multiple sections (Testing, Modules, File System, and Getting Started), expanding the documentation set with new guides and examples.
Changes:
- Adds a new “test-runner” documentation series (introduction, usage, mocking, and coverage).
- Adds “modules” documentation pages (streams, backpressure, ABI stability, publishing packages).
- Adds/updates several “getting-started” and “manipulating-files” guides with examples and reference links.
Reviewed changes
Copilot reviewed 1 out of 23 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pages/test-runner/using-test-runner.md | New guide on structuring Node’s test runner usage with setup patterns and examples |
| pages/test-runner/mocking.md | New guide covering mocking strategies with node:test, Undici, and timers |
| pages/test-runner/introduction.md | New introductory page for the test runner series |
| pages/test-runner/collecting-code-coverage.md | New guide explaining Node’s test coverage support and reporting |
| pages/modules/publishing-node-api-modules.md | New guide on publishing Node-API builds alongside non-Node-API builds |
| pages/modules/publishing-a-package.md | Large guide on packaging/publishing formats (CJS/ESM) and exports configuration |
| pages/modules/how-to-use-streams.md | Comprehensive streams guide (types, pipeline, async iterators, Web Streams interop) |
| pages/modules/backpressuring-in-streams.md | Backpressure deep dive and implementation guidelines |
| pages/modules/abi-stability.md | ABI stability and N-API overview |
| pages/manipulating-files/writing-files-with-nodejs.md | File-writing guide with callback/sync/promise examples |
| pages/manipulating-files/working-with-folders-in-nodejs.md | Folder operations guide (mkdir, readdir, rename, remove) |
| pages/manipulating-files/working-with-file-descriptors-in-nodejs.md | File descriptor concepts and APIs (callback/sync/promises) |
| pages/manipulating-files/working-with-different-filesystems.md | Best practices for cross-filesystem behavior differences |
| pages/manipulating-files/reading-files-with-nodejs.md | File-reading guide including a streams-based example |
| pages/manipulating-files/nodejs-file-stats.md | File stats (fs.stat) guide and examples |
| pages/manipulating-files/nodejs-file-paths.md | Path handling basics (path.dirname/basename/extname/join/resolve) |
| pages/getting-started/websocket.md | New guide on Node’s built-in WebSocket client usage |
| pages/getting-started/security-best-practices.md | Security best practices guide, threat list, and mitigations |
| pages/getting-started/profiling.md | Profiling guide using Node’s built-in V8 tick profiler |
| pages/getting-started/fetch.md | Fetch/Undici guide including pooling and streaming examples |
| pages/getting-started/debugging.md | Debugging/inspector guide and security implications |
| pages/getting-started/an-introduction-to-the-npm-package-manager.md | npm basics guide (install/update/versioning/scripts) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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 PR hotfixes the structure to be 1:1 with the previous implementation, as to avoid breakages. We can discuss the new structure in a seperate issue