-
-
Notifications
You must be signed in to change notification settings - Fork 6.4k
docs: Mention --disable-sigusr1 in getting started guide #7857
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
Conversation
Signed-off-by: Daniel <16339876+dreusel@users.noreply.github.com>
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the getting started guide by adding an entry for the --disable-sigusr1 flag in the debugging table.
- Added documentation for the --disable-sigusr1 flag
- Provides version details indicating when the flag was introduced
Comments suppressed due to low confidence (1)
apps/site/pages/en/learn/getting-started/debugging.md:132
- Consider listing versions in ascending order (e.g., v22.14.0, v23.7.0) for improved clarity and consistency with other version notations.
| --disable-sigusr1 | Disable the ability of starting a debugging session by sending a SIGUSR1 signal to the process (since Node v23.7.0, v22.14.0). |
That's a little advanced for beginners, no? |
Possibly so. I landed on the page as a non-beginner and it would have helped me, but I could imagine the maintainer not adding it for your reason. |
I mean, it is a beginner page, but it doesn't hurt to add the flag, so LGTM. It's not like we are over complicating it, it's a single table entry |
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## main #7857 +/- ##
=======================================
Coverage 75.43% 75.43%
=======================================
Files 101 101
Lines 8305 8306 +1
Branches 218 218
=======================================
+ Hits 6265 6266 +1
Misses 2038 2038
Partials 2 2 ☔ View full report in Codecov by Sentry. |
Co-authored-by: Aviv Keller <me@aviv.sh> Signed-off-by: Daniel <16339876+dreusel@users.noreply.github.com>
Lighthouse Results
|
Description
Mention --disable-sigusr1 in getting started guide
Validation
I took it from the node.js documentation site (https://nodejs.org/api/cli.html#--disable-sigusr1)
Related Issues
None so far
Check List
pnpm format
to ensure the code follows the style guide.pnpm test
to check if all tests are passing.pnpm build
to check if the website builds without errors.