From 63ad821b52b444687a623431b98a2845b5ceef0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guilherme=20Ara=C3=BAjo?= Date: Mon, 28 Jul 2025 19:32:24 -0300 Subject: [PATCH 1/7] doc: add missing llm_description --- doc/api/async_context.md | 2 + doc/api/esm.md | 2 + doc/api/module.md | 2 + doc/api/packages.md | 100 ++++++++++++++++++++------------------- doc/api/synopsis.md | 2 + doc/api/typescript.md | 1 + 6 files changed, 60 insertions(+), 49 deletions(-) diff --git a/doc/api/async_context.md b/doc/api/async_context.md index dd3b6a834ec9..569d89f301ec 100644 --- a/doc/api/async_context.md +++ b/doc/api/async_context.md @@ -6,6 +6,8 @@ + + ## Introduction These classes are used to associate state and propagate it throughout diff --git a/doc/api/esm.md b/doc/api/esm.md index f6ac6f457b89..b43a97fdebd1 100644 --- a/doc/api/esm.md +++ b/doc/api/esm.md @@ -2,6 +2,8 @@ + + + + diff --git a/doc/api/packages.md b/doc/api/packages.md index 429b1b19b908..12b3d985ee49 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -4,6 +4,8 @@ + + -* Type: {string} +- Type: {string} ```json { @@ -1001,7 +1003,7 @@ The `"name"` field can be used in addition to the [`"exports"`][] field to added: v0.4.0 --> -* Type: {string} +- Type: {string} ```json { @@ -1010,7 +1012,7 @@ added: v0.4.0 ``` The `"main"` field defines the entry point of a package when imported by name -via a `node_modules` lookup. Its value is a path. +via a `node_modules` lookup. Its value is a path. The [`"exports"`][] field, if it exists, takes precedence over the `"main"` field when importing the package by name. @@ -1035,7 +1037,7 @@ changes: description: Unflag `--experimental-modules`. --> -* Type: {string} +- Type: {string} The `"type"` field defines the module format that Node.js uses for all `.js` files that have that `package.json` file as their nearest parent. @@ -1046,7 +1048,7 @@ Files ending with `.js` are loaded as ES modules when the nearest parent The nearest parent `package.json` is defined as the first `package.json` found when searching in the current folder, that folder's parent, and so on up -until a node\_modules folder or the volume root is reached. +until a node_modules folder or the volume root is reached. ```json // package.json @@ -1108,7 +1110,7 @@ changes: description: Implement conditional exports. --> -* Type: {Object|string|string\[]} +- Type: {Object|string|string\[]} ```json { @@ -1137,7 +1139,7 @@ added: - v12.19.0 --> -* Type: {Object} +- Type: {Object} ```json // package.json diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md index 24bb35e08f8c..fde11178fb84 100644 --- a/doc/api/synopsis.md +++ b/doc/api/synopsis.md @@ -1,5 +1,7 @@ # Usage and example + + diff --git a/doc/api/typescript.md b/doc/api/typescript.md index 19ddc75c105b..135afd084ef5 100644 --- a/doc/api/typescript.md +++ b/doc/api/typescript.md @@ -28,6 +28,7 @@ changes: > Stability: 2 - Stable + ## Enabling From 50414060d1618dbdc1ce67cd745bd9d3e16e2a99 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guilherme=20Ara=C3=BAjo?= Date: Mon, 28 Jul 2025 20:29:53 -0300 Subject: [PATCH 2/7] doc: improve llm.txt descriptions --- doc/api/async_hooks.md | 2 + doc/api/cluster.md | 2 + doc/api/debugger.md | 2 + doc/api/deprecations.md | 2 + doc/api/diagnostics_channel.md | 2 + doc/api/domain.md | 2 + doc/api/errors.md | 2 + doc/api/globals.md | 2 + doc/api/http.md | 2 + doc/api/http2.md | 2 + doc/api/index.md | 2 + doc/api/inspector.md | 2 + doc/api/modules.md | 2 + doc/api/os.md | 2 + doc/api/packages.md | 98 +++++++++++++++++----------------- doc/api/path.md | 2 + doc/api/querystring.md | 2 + doc/api/quic.md | 2 + doc/api/repl.md | 2 + doc/api/sqlite.md | 2 + doc/api/string_decoder.md | 2 + doc/api/test.md | 2 + doc/api/tls.md | 2 + doc/api/tty.md | 2 + doc/api/url.md | 2 + doc/api/v8.md | 2 + doc/api/worker_threads.md | 2 + 27 files changed, 101 insertions(+), 49 deletions(-) diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index a863350fc2d2..c969d12c8325 100644 --- a/doc/api/async_hooks.md +++ b/doc/api/async_hooks.md @@ -2,6 +2,8 @@ + + > Stability: 1 - Experimental. Please migrate away from this API, if you can. > We do not recommend using the [`createHook`][], [`AsyncHook`][], and > [`executionAsyncResource`][] APIs as they have usability issues, safety risks, diff --git a/doc/api/cluster.md b/doc/api/cluster.md index fa9942f4668b..e09580547401 100644 --- a/doc/api/cluster.md +++ b/doc/api/cluster.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable diff --git a/doc/api/debugger.md b/doc/api/debugger.md index ce25c927d8ef..c9c1292d50e5 100644 --- a/doc/api/debugger.md +++ b/doc/api/debugger.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index baeabb78505c..01ccfe746e2c 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -2,6 +2,8 @@ + + Node.js APIs might be deprecated for any of the following reasons: diff --git a/doc/api/diagnostics_channel.md b/doc/api/diagnostics_channel.md index 1c5e2b6535ad..f1a4e55ba6bc 100644 --- a/doc/api/diagnostics_channel.md +++ b/doc/api/diagnostics_channel.md @@ -14,6 +14,8 @@ changes: + + > Stability: 2 - Stable diff --git a/doc/api/domain.md b/doc/api/domain.md index 4838d4d4a7ef..49469b7476f4 100644 --- a/doc/api/domain.md +++ b/doc/api/domain.md @@ -17,6 +17,8 @@ changes: + + > Stability: 0 - Deprecated diff --git a/doc/api/errors.md b/doc/api/errors.md index 65ef2ce7bf5d..0b02afe84011 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -2,6 +2,8 @@ + + Applications running in Node.js will generally experience the following diff --git a/doc/api/globals.md b/doc/api/globals.md index 6c0caca06d3d..1c94ec4f0ddb 100644 --- a/doc/api/globals.md +++ b/doc/api/globals.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable diff --git a/doc/api/http.md b/doc/api/http.md index 23b63ec9d7cd..9ffbdc8a1865 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable diff --git a/doc/api/http2.md b/doc/api/http2.md index 759430a0f34c..c87bfc4ebf8b 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -19,6 +19,8 @@ changes: + + > Stability: 2 - Stable diff --git a/doc/api/index.md b/doc/api/index.md index 8a2b602cec7a..0a1d36fb805d 100644 --- a/doc/api/index.md +++ b/doc/api/index.md @@ -2,6 +2,8 @@ + + * [About this documentation](documentation.md) * [Usage and example](synopsis.md) diff --git a/doc/api/inspector.md b/doc/api/inspector.md index d5401e837894..c401959c2fe3 100644 --- a/doc/api/inspector.md +++ b/doc/api/inspector.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable diff --git a/doc/api/modules.md b/doc/api/modules.md index 84252b9819d2..7e133bc2d2b2 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable diff --git a/doc/api/os.md b/doc/api/os.md index 9f2aa0390cc5..d5ca74fda548 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable diff --git a/doc/api/packages.md b/doc/api/packages.md index 12b3d985ee49..281cf98b7aff 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -63,15 +63,15 @@ Node.js will treat the following as [ES modules][] when passed to `node` as the initial input, or when referenced by `import` statements or `import()` expressions: -- Files with an `.mjs` extension. +* Files with an `.mjs` extension. -- Files with a `.js` extension when the nearest parent `package.json` file +* Files with a `.js` extension when the nearest parent `package.json` file contains a top-level [`"type"`][] field with a value of `"module"`. -- Strings passed in as an argument to `--eval`, or piped to `node` via `STDIN`, +* Strings passed in as an argument to `--eval`, or piped to `node` via `STDIN`, with the flag `--input-type=module`. -- Code containing syntax only successfully parsed as [ES modules][], such as +* Code containing syntax only successfully parsed as [ES modules][], such as `import` or `export` statements or `import.meta`, with no explicit marker of how it should be interpreted. Explicit markers are `.mjs` or `.cjs` extensions, `package.json` `"type"` fields with either `"module"` or @@ -83,15 +83,15 @@ Node.js will treat the following as [CommonJS][] when passed to `node` as the initial input, or when referenced by `import` statements or `import()` expressions: -- Files with a `.cjs` extension. +* Files with a `.cjs` extension. -- Files with a `.js` extension when the nearest parent `package.json` file +* Files with a `.js` extension when the nearest parent `package.json` file contains a top-level field [`"type"`][] with a value of `"commonjs"`. -- Strings passed in as an argument to `--eval` or `--print`, or piped to `node` +* Strings passed in as an argument to `--eval` or `--print`, or piped to `node` via `STDIN`, with the flag `--input-type=commonjs`. -- Files with a `.js` extension with no parent `package.json` file or where the +* Files with a `.js` extension with no parent `package.json` file or where the nearest parent `package.json` file lacks a `type` field, and where the code can evaluate successfully as CommonJS. In other words, Node.js tries to run such "ambiguous" files as CommonJS first, and will retry evaluating them as ES @@ -129,19 +129,19 @@ as an ES module. Ambiguous input is defined as: -- Files with a `.js` extension or no extension; and either no controlling +* Files with a `.js` extension or no extension; and either no controlling `package.json` file or one that lacks a `type` field. -- String input (`--eval` or `STDIN`) when `--input-type`is not specified. +* String input (`--eval` or `STDIN`) when `--input-type`is not specified. ES module syntax is defined as syntax that would throw when evaluated as CommonJS. This includes the following: -- `import` statements (but _not_ `import()` expressions, which are valid in +* `import` statements (but _not_ `import()` expressions, which are valid in CommonJS). -- `export` statements. -- `import.meta` references. -- `await` at the top level of a module. -- Lexical redeclarations of the CommonJS wrapper variables (`require`, `module`, +* `export` statements. +* `import.meta` references. +* `await` at the top level of a module. +* Lexical redeclarations of the CommonJS wrapper variables (`require`, `module`, `exports`, `__dirname`, `__filename`). ### Module resolution and loading @@ -241,12 +241,12 @@ import 'commonjs-package/src/index.mjs'; The `.mjs` and `.cjs` extensions can be used to mix types within the same package: -- Within a `"type": "module"` package, Node.js can be instructed to +* Within a `"type": "module"` package, Node.js can be instructed to interpret a particular file as [CommonJS][] by naming it with a `.cjs` extension (since both `.js` and `.mjs` files are treated as ES modules within a `"module"` package). -- Within a `"type": "commonjs"` package, Node.js can be instructed to +* Within a `"type": "commonjs"` package, Node.js can be instructed to interpret a particular file as an [ES module][] by naming it with an `.mjs` extension (since both `.js` and `.cjs` files are treated as CommonJS within a `"commonjs"` package). @@ -461,8 +461,8 @@ keys) must be relative URL strings starting with `./`. { "name": "my-package", "exports": { - ".": "./dist/main.js", // Correct - "./feature": "./lib/feature.js" // Correct + ".": "./dist/main.js", // Correct + "./feature": "./lib/feature.js", // Correct // "./origin-relative": "/dist/main.js", // Incorrect: Must start with ./ // "./absolute": "file:///dev/null", // Incorrect: Must start with ./ // "./outside": "../common/util.js" // Incorrect: Must start with ./ @@ -472,9 +472,9 @@ keys) must be relative URL strings starting with `./`. Reasons for this behavior include: -- **Security:** Prevents exporting arbitrary files from outside the +* **Security:** Prevents exporting arbitrary files from outside the package's own directory. -- **Encapsulation:** Ensures all exported paths are resolved relative to +* **Encapsulation:** Ensures all exported paths are resolved relative to the package root, making the package self-contained. ##### No path traversal or invalid segments @@ -691,28 +691,28 @@ For example, a package that wants to provide different ES module exports for Node.js implements the following conditions, listed in order from most specific to least specific as conditions should be defined: -- `"node-addons"` - similar to `"node"` and matches for any Node.js environment. +* `"node-addons"` - similar to `"node"` and matches for any Node.js environment. This condition can be used to provide an entry point which uses native C++ addons as opposed to an entry point which is more universal and doesn't rely on native addons. This condition can be disabled via the [`--no-addons` flag][]. -- `"node"` - matches for any Node.js environment. Can be a CommonJS or ES +* `"node"` - matches for any Node.js environment. Can be a CommonJS or ES module file. _In most cases explicitly calling out the Node.js platform is not necessary._ -- `"import"` - matches when the package is loaded via `import` or +* `"import"` - matches when the package is loaded via `import` or `import()`, or via any top-level import or resolve operation by the ECMAScript module loader. Applies regardless of the module format of the target file. _Always mutually exclusive with `"require"`._ -- `"require"` - matches when the package is loaded via `require()`. The +* `"require"` - matches when the package is loaded via `require()`. The referenced file should be loadable with `require()` although the condition matches regardless of the module format of the target file. Expected formats include CommonJS, JSON, native addons, and ES modules. _Always mutually exclusive with `"import"`._ -- `"module-sync"` - matches no matter the package is loaded via `import`, +* `"module-sync"` - matches no matter the package is loaded via `import`, `import()` or `require()`. The format is expected to be ES modules that does not contain top-level await in its module graph - if it does, `ERR_REQUIRE_ASYNC_MODULE` will be thrown when the module is `require()`-ed. -- `"default"` - the generic fallback that always matches. Can be a CommonJS +* `"default"` - the generic fallback that always matches. Can be a CommonJS or ES module file. _This condition should always come last._ Within the [`"exports"`][] object, key order is significant. During condition @@ -827,14 +827,14 @@ Since custom package conditions require clear definitions to ensure correct usage, a list of common known package conditions and their strict definitions is provided below to assist with ecosystem coordination. -- `"types"` - can be used by typing systems to resolve the typing file for +* `"types"` - can be used by typing systems to resolve the typing file for the given export. _This condition should always be included first._ -- `"browser"` - any web browser environment. -- `"development"` - can be used to define a development-only environment +* `"browser"` - any web browser environment. +* `"development"` - can be used to define a development-only environment entry point, for example to provide additional debugging context such as better error messages when running in a development mode. _Must always be mutually exclusive with `"production"`._ -- `"production"` - can be used to define a production environment entry +* `"production"` - can be used to define a production environment entry point. _Must always be mutually exclusive with `"development"`._ For other runtimes, platform-specific condition key definitions are maintained @@ -844,16 +844,16 @@ New conditions definitions may be added to this list by creating a pull request to the [Node.js documentation for this section][]. The requirements for listing a new condition definition here are that: -- The definition should be clear and unambiguous for all implementers. -- The use case for why the condition is needed should be clearly justified. -- There should exist sufficient existing implementation usage. -- The condition name should not conflict with another condition definition or +* The definition should be clear and unambiguous for all implementers. +* The use case for why the condition is needed should be clearly justified. +* There should exist sufficient existing implementation usage. +* The condition name should not conflict with another condition definition or condition in wide usage. -- The listing of the condition definition should provide a coordination +* The listing of the condition definition should provide a coordination benefit to the ecosystem that wouldn't otherwise be possible. For example, this would not necessarily be the case for company-specific or application-specific conditions. -- The condition should be such that a Node.js user would expect it to be in +* The condition should be such that a Node.js user would expect it to be in Node.js core documentation. The `"types"` condition is a good example: It doesn't really belong in the [Runtime Keys][] proposal but is a good fit here in the Node.js docs. @@ -957,15 +957,15 @@ additional fields which are ignored by Node.js and not documented here. The following fields in `package.json` files are used in Node.js: -- [`"name"`][] - Relevant when using named imports within a package. Also used +* [`"name"`][] - Relevant when using named imports within a package. Also used by package managers as the name of the package. -- [`"main"`][] - The default module when loading the package, if exports is not +* [`"main"`][] - The default module when loading the package, if exports is not specified, and in versions of Node.js prior to the introduction of exports. -- [`"type"`][] - The package type determining whether to load `.js` files as +* [`"type"`][] - The package type determining whether to load `.js` files as CommonJS or ES modules. -- [`"exports"`][] - Package exports and conditional exports. When present, +* [`"exports"`][] - Package exports and conditional exports. When present, limits which submodules can be loaded from within the package. -- [`"imports"`][] - Package imports, for use by modules within the package +* [`"imports"`][] - Package imports, for use by modules within the package itself. ### `"name"` @@ -982,7 +982,7 @@ changes: description: Remove the `--experimental-resolve-self` option. --> -- Type: {string} +* Type: {string} ```json { @@ -1003,7 +1003,7 @@ The `"name"` field can be used in addition to the [`"exports"`][] field to added: v0.4.0 --> -- Type: {string} +* Type: {string} ```json { @@ -1012,7 +1012,7 @@ added: v0.4.0 ``` The `"main"` field defines the entry point of a package when imported by name -via a `node_modules` lookup. Its value is a path. +via a `node_modules` lookup. Its value is a path. The [`"exports"`][] field, if it exists, takes precedence over the `"main"` field when importing the package by name. @@ -1037,7 +1037,7 @@ changes: description: Unflag `--experimental-modules`. --> -- Type: {string} +* Type: {string} The `"type"` field defines the module format that Node.js uses for all `.js` files that have that `package.json` file as their nearest parent. @@ -1048,7 +1048,7 @@ Files ending with `.js` are loaded as ES modules when the nearest parent The nearest parent `package.json` is defined as the first `package.json` found when searching in the current folder, that folder's parent, and so on up -until a node_modules folder or the volume root is reached. +until a node\_modules folder or the volume root is reached. ```json // package.json @@ -1110,7 +1110,7 @@ changes: description: Implement conditional exports. --> -- Type: {Object|string|string\[]} +* Type: {Object|string|string\[]} ```json { @@ -1139,7 +1139,7 @@ added: - v12.19.0 --> -- Type: {Object} +* Type: {Object} ```json // package.json diff --git a/doc/api/path.md b/doc/api/path.md index e5d6fd7ef683..6f8f611fe357 100644 --- a/doc/api/path.md +++ b/doc/api/path.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable diff --git a/doc/api/querystring.md b/doc/api/querystring.md index f7f45d57d927..016c69d0577e 100644 --- a/doc/api/querystring.md +++ b/doc/api/querystring.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable diff --git a/doc/api/quic.md b/doc/api/quic.md index 723c26c5bd0b..38eb4f9ddf5a 100644 --- a/doc/api/quic.md +++ b/doc/api/quic.md @@ -2,6 +2,8 @@ + + diff --git a/doc/api/repl.md b/doc/api/repl.md index c26b2a56dc8a..e6d2677f005d 100644 --- a/doc/api/repl.md +++ b/doc/api/repl.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable diff --git a/doc/api/sqlite.md b/doc/api/sqlite.md index a5c5fd6cec2b..6dbaba58b01c 100644 --- a/doc/api/sqlite.md +++ b/doc/api/sqlite.md @@ -2,6 +2,8 @@ + + + + > Stability: 2 - Stable diff --git a/doc/api/test.md b/doc/api/test.md index 3d245c2303b1..41eeddb69065 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -2,6 +2,8 @@ + + + + > Stability: 2 - Stable diff --git a/doc/api/tty.md b/doc/api/tty.md index a7c4c3a48d87..b265da15dec0 100644 --- a/doc/api/tty.md +++ b/doc/api/tty.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable diff --git a/doc/api/url.md b/doc/api/url.md index d5dc06055b6c..aba3bf4e396b 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable diff --git a/doc/api/v8.md b/doc/api/v8.md index 7ee7a748674c..f8655a22c11a 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -2,6 +2,8 @@ + + The `node:v8` module exposes APIs that are specific to the version of [V8][] diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index 32024e972932..d8f3b1732949 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable From 16bca4ae6165764607c1146b6dc0499e9e4aa3ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guilherme=20Ara=C3=BAjo?= Date: Wed, 30 Jul 2025 20:09:07 -0300 Subject: [PATCH 3/7] doc: break long descriptions --- doc/api/async_context.md | 8 +++++++- doc/api/async_hooks.md | 7 ++++++- doc/api/cluster.md | 7 ++++++- doc/api/debugger.md | 6 +++++- doc/api/deprecations.md | 5 ++++- doc/api/diagnostics_channel.md | 7 ++++++- doc/api/domain.md | 5 ++++- doc/api/errors.md | 5 ++++- doc/api/esm.md | 6 +++++- doc/api/globals.md | 5 ++++- doc/api/http.md | 6 +++++- doc/api/inspector.md | 6 +++++- doc/api/module.md | 7 ++++++- doc/api/modules.md | 6 +++++- doc/api/os.md | 7 ++++++- doc/api/packages.md | 7 ++++++- doc/api/path.md | 6 +++++- doc/api/querystring.md | 6 +++++- doc/api/repl.md | 6 ++++-- doc/api/sqlite.md | 7 ++++++- doc/api/string_decoder.md | 6 +++++- doc/api/synopsis.md | 6 +++++- doc/api/test.md | 7 ++++++- doc/api/tls.md | 6 +++++- doc/api/tty.md | 6 +++++- doc/api/typescript.md | 7 ++++++- doc/api/url.md | 5 ++++- doc/api/v8.md | 6 +++++- doc/api/worker_threads.md | 8 ++++++-- 29 files changed, 151 insertions(+), 31 deletions(-) diff --git a/doc/api/async_context.md b/doc/api/async_context.md index 569d89f301ec..f63e23d40959 100644 --- a/doc/api/async_context.md +++ b/doc/api/async_context.md @@ -6,7 +6,13 @@ - + ## Introduction diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index c969d12c8325..b17139565ee6 100644 --- a/doc/api/async_hooks.md +++ b/doc/api/async_hooks.md @@ -2,7 +2,12 @@ - + > Stability: 1 - Experimental. Please migrate away from this API, if you can. > We do not recommend using the [`createHook`][], [`AsyncHook`][], and diff --git a/doc/api/cluster.md b/doc/api/cluster.md index e09580547401..fda00bd07526 100644 --- a/doc/api/cluster.md +++ b/doc/api/cluster.md @@ -2,7 +2,12 @@ - + > Stability: 2 - Stable diff --git a/doc/api/debugger.md b/doc/api/debugger.md index c9c1292d50e5..cd40eb2c7155 100644 --- a/doc/api/debugger.md +++ b/doc/api/debugger.md @@ -2,7 +2,11 @@ - + > Stability: 2 - Stable diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 01ccfe746e2c..b83f700c5d67 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -2,7 +2,10 @@ - + diff --git a/doc/api/diagnostics_channel.md b/doc/api/diagnostics_channel.md index f1a4e55ba6bc..7906cb2b410d 100644 --- a/doc/api/diagnostics_channel.md +++ b/doc/api/diagnostics_channel.md @@ -14,7 +14,12 @@ changes: - + > Stability: 2 - Stable diff --git a/doc/api/domain.md b/doc/api/domain.md index 49469b7476f4..ac98ab99d7df 100644 --- a/doc/api/domain.md +++ b/doc/api/domain.md @@ -17,7 +17,10 @@ changes: - + > Stability: 0 - Deprecated diff --git a/doc/api/errors.md b/doc/api/errors.md index 0b02afe84011..1c43f233a6a8 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -2,7 +2,10 @@ - + diff --git a/doc/api/esm.md b/doc/api/esm.md index b43a97fdebd1..a3112d3f74fd 100644 --- a/doc/api/esm.md +++ b/doc/api/esm.md @@ -2,7 +2,11 @@ - + diff --git a/doc/api/globals.md b/doc/api/globals.md index 1c94ec4f0ddb..944bf52519c0 100644 --- a/doc/api/globals.md +++ b/doc/api/globals.md @@ -2,7 +2,10 @@ - + diff --git a/doc/api/http.md b/doc/api/http.md index 9ffbdc8a1865..efe795e25f46 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -2,7 +2,11 @@ - + > Stability: 2 - Stable diff --git a/doc/api/inspector.md b/doc/api/inspector.md index c401959c2fe3..8d3ef3d9a83f 100644 --- a/doc/api/inspector.md +++ b/doc/api/inspector.md @@ -2,7 +2,11 @@ - + > Stability: 2 - Stable diff --git a/doc/api/module.md b/doc/api/module.md index 0013cefb1dc2..ce60ebf817e0 100644 --- a/doc/api/module.md +++ b/doc/api/module.md @@ -2,7 +2,12 @@ - + - + > Stability: 2 - Stable diff --git a/doc/api/os.md b/doc/api/os.md index d5ca74fda548..e1c406bd904d 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -2,7 +2,12 @@ - + > Stability: 2 - Stable diff --git a/doc/api/packages.md b/doc/api/packages.md index 281cf98b7aff..9a50c2717bb1 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -4,7 +4,12 @@ - + - + > Stability: 2 - Stable diff --git a/doc/api/querystring.md b/doc/api/querystring.md index 016c69d0577e..d9d2e038e717 100644 --- a/doc/api/querystring.md +++ b/doc/api/querystring.md @@ -2,7 +2,11 @@ - + > Stability: 2 - Stable diff --git a/doc/api/repl.md b/doc/api/repl.md index e6d2677f005d..b79bc68a219d 100644 --- a/doc/api/repl.md +++ b/doc/api/repl.md @@ -2,8 +2,10 @@ - - + > Stability: 2 - Stable diff --git a/doc/api/sqlite.md b/doc/api/sqlite.md index 6dbaba58b01c..40b8937ae1c3 100644 --- a/doc/api/sqlite.md +++ b/doc/api/sqlite.md @@ -2,7 +2,12 @@ - + - + > Stability: 2 - Stable diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md index fde11178fb84..b22c8d73dda7 100644 --- a/doc/api/synopsis.md +++ b/doc/api/synopsis.md @@ -1,6 +1,10 @@ # Usage and example - + diff --git a/doc/api/test.md b/doc/api/test.md index 41eeddb69065..6f5f83ae51ea 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -2,7 +2,12 @@ - + - + > Stability: 2 - Stable diff --git a/doc/api/tty.md b/doc/api/tty.md index b265da15dec0..e4bb460b9ca5 100644 --- a/doc/api/tty.md +++ b/doc/api/tty.md @@ -2,7 +2,11 @@ - + > Stability: 2 - Stable diff --git a/doc/api/typescript.md b/doc/api/typescript.md index 135afd084ef5..fe8f9781f6f1 100644 --- a/doc/api/typescript.md +++ b/doc/api/typescript.md @@ -28,7 +28,12 @@ changes: > Stability: 2 - Stable - + + ## Enabling diff --git a/doc/api/url.md b/doc/api/url.md index aba3bf4e396b..30f24738f0fc 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -2,7 +2,10 @@ - + > Stability: 2 - Stable diff --git a/doc/api/v8.md b/doc/api/v8.md index f8655a22c11a..0417dfe21411 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -2,7 +2,11 @@ - + diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index d8f3b1732949..6502e5349057 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -2,8 +2,12 @@ - - + > Stability: 2 - Stable From bf1aa42e8476d9d3ecf9c94210a179fd9f06d8d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guilherme=20Ara=C3=BAjo?= Date: Wed, 30 Jul 2025 20:24:03 -0300 Subject: [PATCH 4/7] doc: fix formatting --- doc/api/repl.md | 1 + doc/api/worker_threads.md | 1 + 2 files changed, 2 insertions(+) diff --git a/doc/api/repl.md b/doc/api/repl.md index b79bc68a219d..174f30ba640e 100644 --- a/doc/api/repl.md +++ b/doc/api/repl.md @@ -6,6 +6,7 @@ llm_description: > Provides an interactive Read-Eval-Print-Loop (REPL) implementation. --> + > Stability: 2 - Stable diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index 6502e5349057..39e6a357d71f 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -8,6 +8,7 @@ llm_description: > useful for performing CPU-intensive operations without blocking the main application's event loop. --> + > Stability: 2 - Stable From a521410867cb2711e646f45bccb1ca315336f33c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guilherme=20Ara=C3=BAjo?= Date: Wed, 30 Jul 2025 20:36:17 -0300 Subject: [PATCH 5/7] doc: fix formatting --- doc/api/async_context.md | 2 +- doc/api/async_hooks.md | 2 +- doc/api/cluster.md | 2 +- doc/api/debugger.md | 2 +- doc/api/deprecations.md | 2 +- doc/api/diagnostics_channel.md | 2 +- doc/api/domain.md | 2 +- doc/api/errors.md | 2 +- doc/api/esm.md | 2 +- doc/api/globals.md | 2 +- doc/api/http.md | 2 +- doc/api/http2.md | 2 +- doc/api/index.md | 2 +- doc/api/inspector.md | 2 +- doc/api/module.md | 2 +- doc/api/modules.md | 2 +- doc/api/os.md | 2 +- doc/api/packages.md | 2 +- doc/api/path.md | 2 +- doc/api/querystring.md | 2 +- doc/api/quic.md | 2 +- doc/api/repl.md | 2 +- doc/api/sqlite.md | 2 +- doc/api/string_decoder.md | 2 +- doc/api/synopsis.md | 2 +- doc/api/test.md | 2 +- doc/api/tls.md | 2 +- doc/api/tty.md | 2 +- doc/api/typescript.md | 2 +- doc/api/url.md | 2 +- doc/api/v8.md | 2 +- doc/api/worker_threads.md | 2 +- 32 files changed, 32 insertions(+), 32 deletions(-) diff --git a/doc/api/async_context.md b/doc/api/async_context.md index f63e23d40959..845aab6c15c8 100644 --- a/doc/api/async_context.md +++ b/doc/api/async_context.md @@ -7,7 +7,7 @@ diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index b83f700c5d67..c20d7cb61848 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -3,7 +3,7 @@ diff --git a/doc/api/diagnostics_channel.md b/doc/api/diagnostics_channel.md index 7906cb2b410d..e6b5747c78e0 100644 --- a/doc/api/diagnostics_channel.md +++ b/doc/api/diagnostics_channel.md @@ -15,7 +15,7 @@ changes: diff --git a/doc/api/errors.md b/doc/api/errors.md index 1c43f233a6a8..0d32f1a5d1da 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -3,7 +3,7 @@ diff --git a/doc/api/esm.md b/doc/api/esm.md index a3112d3f74fd..345a0e87ac11 100644 --- a/doc/api/esm.md +++ b/doc/api/esm.md @@ -3,7 +3,7 @@ diff --git a/doc/api/globals.md b/doc/api/globals.md index 944bf52519c0..635c80909940 100644 --- a/doc/api/globals.md +++ b/doc/api/globals.md @@ -3,7 +3,7 @@ diff --git a/doc/api/http.md b/doc/api/http.md index efe795e25f46..aaeae62a467b 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -3,7 +3,7 @@ diff --git a/doc/api/http2.md b/doc/api/http2.md index c87bfc4ebf8b..2a687fc397e6 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -19,7 +19,7 @@ changes: - + > Stability: 2 - Stable diff --git a/doc/api/index.md b/doc/api/index.md index 0a1d36fb805d..33db10189e79 100644 --- a/doc/api/index.md +++ b/doc/api/index.md @@ -2,7 +2,7 @@ - + * [About this documentation](documentation.md) * [Usage and example](synopsis.md) diff --git a/doc/api/inspector.md b/doc/api/inspector.md index 8d3ef3d9a83f..69d9db2d4806 100644 --- a/doc/api/inspector.md +++ b/doc/api/inspector.md @@ -3,7 +3,7 @@ diff --git a/doc/api/module.md b/doc/api/module.md index ce60ebf817e0..559fd89c0651 100644 --- a/doc/api/module.md +++ b/doc/api/module.md @@ -3,7 +3,7 @@ diff --git a/doc/api/os.md b/doc/api/os.md index e1c406bd904d..0eea87812f0c 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -3,7 +3,7 @@ diff --git a/doc/api/querystring.md b/doc/api/querystring.md index d9d2e038e717..85f3f847c59b 100644 --- a/doc/api/querystring.md +++ b/doc/api/querystring.md @@ -3,7 +3,7 @@ diff --git a/doc/api/quic.md b/doc/api/quic.md index 38eb4f9ddf5a..196011638e42 100644 --- a/doc/api/quic.md +++ b/doc/api/quic.md @@ -2,7 +2,7 @@ - + diff --git a/doc/api/sqlite.md b/doc/api/sqlite.md index 40b8937ae1c3..03a12d8a3d9b 100644 --- a/doc/api/sqlite.md +++ b/doc/api/sqlite.md @@ -3,7 +3,7 @@ diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md index b22c8d73dda7..8ad2374f7db8 100644 --- a/doc/api/synopsis.md +++ b/doc/api/synopsis.md @@ -1,7 +1,7 @@ # Usage and example diff --git a/doc/api/test.md b/doc/api/test.md index 6f5f83ae51ea..c8c56309200b 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -3,7 +3,7 @@ diff --git a/doc/api/tty.md b/doc/api/tty.md index e4bb460b9ca5..23ab9e49246f 100644 --- a/doc/api/tty.md +++ b/doc/api/tty.md @@ -3,7 +3,7 @@ diff --git a/doc/api/typescript.md b/doc/api/typescript.md index fe8f9781f6f1..0d97ebb7f329 100644 --- a/doc/api/typescript.md +++ b/doc/api/typescript.md @@ -30,7 +30,7 @@ changes: > Stability: 2 - Stable diff --git a/doc/api/url.md b/doc/api/url.md index 30f24738f0fc..74cadc551dea 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -3,7 +3,7 @@ diff --git a/doc/api/v8.md b/doc/api/v8.md index 0417dfe21411..f48c6454bb4d 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -3,7 +3,7 @@ diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index 39e6a357d71f..3b5b9ab0f186 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -3,7 +3,7 @@ - + > Stability: 2 - Stable diff --git a/doc/api/index.md b/doc/api/index.md index 33db10189e79..0902afa36a41 100644 --- a/doc/api/index.md +++ b/doc/api/index.md @@ -2,7 +2,7 @@ - + * [About this documentation](documentation.md) * [Usage and example](synopsis.md) diff --git a/doc/api/quic.md b/doc/api/quic.md index 196011638e42..d0556d4e4fd5 100644 --- a/doc/api/quic.md +++ b/doc/api/quic.md @@ -2,7 +2,7 @@ - + diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index c20d7cb61848..b83f700c5d67 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -3,7 +3,7 @@ diff --git a/doc/api/diagnostics_channel.md b/doc/api/diagnostics_channel.md index e6b5747c78e0..7906cb2b410d 100644 --- a/doc/api/diagnostics_channel.md +++ b/doc/api/diagnostics_channel.md @@ -15,7 +15,7 @@ changes: diff --git a/doc/api/errors.md b/doc/api/errors.md index 0d32f1a5d1da..1c43f233a6a8 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -3,7 +3,7 @@ diff --git a/doc/api/esm.md b/doc/api/esm.md index 345a0e87ac11..a3112d3f74fd 100644 --- a/doc/api/esm.md +++ b/doc/api/esm.md @@ -3,7 +3,7 @@ diff --git a/doc/api/globals.md b/doc/api/globals.md index 635c80909940..944bf52519c0 100644 --- a/doc/api/globals.md +++ b/doc/api/globals.md @@ -3,7 +3,7 @@ diff --git a/doc/api/http.md b/doc/api/http.md index aaeae62a467b..efe795e25f46 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -3,7 +3,7 @@ diff --git a/doc/api/http2.md b/doc/api/http2.md index 8985fc8f7c60..9c88fc25ff8c 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -19,7 +19,7 @@ changes: - + > Stability: 2 - Stable diff --git a/doc/api/index.md b/doc/api/index.md index 0902afa36a41..23efc344c746 100644 --- a/doc/api/index.md +++ b/doc/api/index.md @@ -2,7 +2,7 @@ - + * [About this documentation](documentation.md) * [Usage and example](synopsis.md) diff --git a/doc/api/inspector.md b/doc/api/inspector.md index 69d9db2d4806..8d3ef3d9a83f 100644 --- a/doc/api/inspector.md +++ b/doc/api/inspector.md @@ -3,7 +3,7 @@ diff --git a/doc/api/module.md b/doc/api/module.md index 559fd89c0651..ce60ebf817e0 100644 --- a/doc/api/module.md +++ b/doc/api/module.md @@ -3,7 +3,7 @@ diff --git a/doc/api/os.md b/doc/api/os.md index 0eea87812f0c..e1c406bd904d 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -3,7 +3,7 @@ diff --git a/doc/api/querystring.md b/doc/api/querystring.md index 85f3f847c59b..d9d2e038e717 100644 --- a/doc/api/querystring.md +++ b/doc/api/querystring.md @@ -3,7 +3,7 @@ diff --git a/doc/api/quic.md b/doc/api/quic.md index d0556d4e4fd5..21982cde9673 100644 --- a/doc/api/quic.md +++ b/doc/api/quic.md @@ -2,7 +2,7 @@ - + diff --git a/doc/api/sqlite.md b/doc/api/sqlite.md index 03a12d8a3d9b..40b8937ae1c3 100644 --- a/doc/api/sqlite.md +++ b/doc/api/sqlite.md @@ -3,7 +3,7 @@ diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md index 8ad2374f7db8..b22c8d73dda7 100644 --- a/doc/api/synopsis.md +++ b/doc/api/synopsis.md @@ -1,7 +1,7 @@ # Usage and example diff --git a/doc/api/test.md b/doc/api/test.md index c8c56309200b..6f5f83ae51ea 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -3,7 +3,7 @@ diff --git a/doc/api/tty.md b/doc/api/tty.md index 23ab9e49246f..e4bb460b9ca5 100644 --- a/doc/api/tty.md +++ b/doc/api/tty.md @@ -3,7 +3,7 @@ diff --git a/doc/api/typescript.md b/doc/api/typescript.md index 0d97ebb7f329..fe8f9781f6f1 100644 --- a/doc/api/typescript.md +++ b/doc/api/typescript.md @@ -30,7 +30,7 @@ changes: > Stability: 2 - Stable diff --git a/doc/api/url.md b/doc/api/url.md index 74cadc551dea..30f24738f0fc 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -3,7 +3,7 @@ diff --git a/doc/api/v8.md b/doc/api/v8.md index f48c6454bb4d..0417dfe21411 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -3,7 +3,7 @@ diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index 3b5b9ab0f186..39e6a357d71f 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -3,7 +3,7 @@