doc: add --inspect-brk-node

[aymen94]

added in cli documentation --inspect-brk-node.

• documentation is changed or added
• commit message follows commit guidelines

[joyeecheung]

I don't think we should document this, it is for internal debugging only, similar to --expose-internals. It does not actually break on the first JS script ever executed anyway, because the inspector is not started at that point.

The users should use --inspect-brk instead.

[aymen94]

@joyeecheung Ok, thanks.
Is there an internal documentation?

[BridgeAR]

@aymen94 we have a couple internal documentations. Pretty much everything that is not in ./doc/api/ is internal. I personally would not know a good spot to document this in but maybe others have a suggestion. Ping @Trott

[Trott]

Creating something in doc/guides for internal-only undocumented flags (like --expose-internals) would probably be the place to do it.

doc/guides is unfortunate naming because it looks like guides we write for external folks, but those are over in the website repo. At some point, we should rename doc/guides to something else to make it more clear, like doc/internal-guides or doc/project-guides or doc/internal or something like that.

[Trott]

I'm going to close this because we don't want this documented in end-user docs. Feel free to open a new PR for internal documentation though. That would be great.