Repository: nodejs/node
Pull request: tools: fix small inconsistencies in JSON doc output

Taken out of https://github.com/nodejs/node/pull/57343, it simplifies things and should be very safe.

<!--
Before submitting a pull request, please read:

- the CONTRIBUTING guide at https://github.com/nodejs/node/blob/HEAD/CONTRIBUTING.md
- the commit message formatting guidelines at
  https://github.com/nodejs/node/blob/HEAD/doc/contributing/pull-requests.md#commit-message-guidelines

For code changes:
1. Include tests for any bug fixes or new features.
2. Update documentation if relevant.
3. Ensure that `make -j4 test` (UNIX), or `vcbuild test` (Windows) passes.

If you believe this PR should be highlighted in the Node.js CHANGELOG
please add the `notable-change` label.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.
-->


Changed files:
filename: doc/api/report.md
patch: @@ -4,8 +4,6 @@
 
 <!-- type=misc -->
 
-> Stability: 2 - Stable
-
 <!-- name=report -->
 
 <!-- YAML
@@ -22,6 +20,8 @@ changes:
     description: Added `--report-exclude-network` option for excluding networking operations that can slow down report generation in some cases.
 -->
 
+> Stability: 2 - Stable
+
 Delivers a JSON-formatted diagnostic summary, written to a file.
 
 The report is intended for development, test, and production use, to capture

filename: doc/api/synopsis.md
patch: @@ -1,11 +1,11 @@
 # Usage and example
 
-## Usage
-
 <!--introduced_in=v0.10.0-->
 
 <!--type=misc-->
 
+## Usage
+
 `node [options] [V8 options] [script.js | -e "script" | - ] [arguments]`
 
 Please see the [Command-line options][] document for more information.

filename: test/doctool/test-doc-api-json.mjs
patch: @@ -151,7 +151,8 @@ for await (const dirent of await fs.opendir(new URL('../../out/doc/api/', import
     'n-api.md': ['introduced_in', 'stability', 'stabilityText', 'miscs'],
     'packages.md': ['introduced_in', 'meta', 'miscs'],
     'process.md': ['globals'],
-    'report.md': ['introduced_in', 'stability', 'stabilityText', 'meta', 'miscs'],
+    'report.md': ['introduced_in', 'meta', 'stability', 'stabilityText', 'miscs'],
+    'synopsis.md': ['introduced_in', 'miscs'],
   }[dirent.name] ?? ['modules'])]);
 
   assert.partialDeepStrictEqual(allExpectedKeys, findAllKeys(json));