11ty / 11ty/docs

Add Node debugging info to debug docs

Open
#1,807 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Nunjucks
Stars
547
Forks
726
Avg merge
2h 23m
Merged PRs (30d)
3

Description

https://chaos.social/@svenk/114743849460087240

#TIL: You can debug nodejs applications very nicely (remotely) with Chrome/Firefox debuggers. Works like npx --node-options=--inspect @11ty/eleventy (yes, looking at you, @11ty), put some debugger; breakpoint in your code, point your browser to chrome://inspect. Super nice. Learn more at https://nodejs.org/en/learn/getting-started/debugging

https://www.11ty.dev/docs/debugging/

Related: https://www.11ty.dev/docs/debug-performance/#node-js-cpu-profiling

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked debugging documentation page and compare it with the Node.js debugging guide. Add the relevant Node debugging information, including browser inspection and debugger breakpoints, while considering the related Node.js CPU profiling page. Done means the debugging docs clearly explain this workflow and link to the relevant resources.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.