From 4cfdb33497d9f6708bf7914a608db2439f6d4ae1 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 | 134 ++++++++++++++++++++------------------- doc/api/synopsis.md | 2 + doc/api/typescript.md | 2 + 6 files changed, 78 insertions(+), 66 deletions(-) diff --git a/doc/api/async_context.md b/doc/api/async_context.md index dd3b6a834ec950..569d89f301ec4c 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 69ed56801da5d4..1c34d581c75246 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 a676cedf4a7eb6..10d21c8721af7c 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -4,6 +4,8 @@ + + -* Type: {string} +- Type: {string} ```json { @@ -985,7 +987,7 @@ The `"name"` field can be used in addition to the [`"exports"`][] field to added: v0.4.0 --> -* Type: {string} +- Type: {string} ```json { @@ -994,7 +996,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. When a package has an [`"exports"`][] field, this will take precedence over the `"main"` field when importing the package by name. @@ -1019,7 +1021,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. @@ -1030,7 +1032,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 @@ -1092,7 +1094,7 @@ changes: description: Implement conditional exports. --> -* Type: {Object|string|string\[]} +- Type: {Object|string|string\[]} ```json { @@ -1121,7 +1123,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 dda2c5285dc605..f335eed41390f2 100644 --- a/doc/api/synopsis.md +++ b/doc/api/synopsis.md @@ -1,5 +1,7 @@ # Usage and example + + ## Usage diff --git a/doc/api/typescript.md b/doc/api/typescript.md index 642e3f26db7cb3..763581ed31646a 100644 --- a/doc/api/typescript.md +++ b/doc/api/typescript.md @@ -15,6 +15,8 @@ changes: + + > Stability: 1.2 - Release candidate ## Enabling From 94b14494a175a51ff899f497047c7268d18c92a0 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 | 132 ++++++++++++++++----------------- 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, 118 insertions(+), 66 deletions(-) diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index 07793fca90e445..9095c5ff5ffca5 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 fa9942f4668bdf..e09580547401fc 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 03e9cd9185027e..6d52c54b47b720 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 a111b3a0d6ce4e..12b4a3d5edb959 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 1c742f7f972ce0..b5ce57b9aacf0c 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 47f97035fca8d6..d9983e2cd02a51 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 ff8c1ef6f9ce21..769ac727c6e432 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 0de73e58e9414d..5e70c0ebd907e2 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 2148ea36355d17..5e07867d2a40d8 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 decbdecf6e550c..df932b3f9ff02d 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 8db8b8c8806274..31beec4e9f9b1f 100644 --- a/doc/api/index.md +++ b/doc/api/index.md @@ -5,6 +5,8 @@ + + * [About this documentation](documentation.md) * [Usage and example](synopsis.md) diff --git a/doc/api/inspector.md b/doc/api/inspector.md index f56197d5baa403..cbf110076dacf7 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 4ef79b855bd877..5b30e747ad1012 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 9f2aa0390cc56a..d5ca74fda54830 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 10d21c8721af7c..64fa59d3e087f5 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`). ### Modules loaders @@ -150,36 +150,36 @@ Node.js has two systems for resolving a specifier and loading modules. There is the CommonJS module loader: -- It is fully synchronous. -- It is responsible for handling `require()` calls. -- It is monkey patchable. -- It supports [folders as modules][]. -- When resolving a specifier, if no exact match is found, it will try to add +* It is fully synchronous. +* It is responsible for handling `require()` calls. +* It is monkey patchable. +* It supports [folders as modules][]. +* When resolving a specifier, if no exact match is found, it will try to add extensions (`.js`, `.json`, and finally `.node`) and then attempt to resolve [folders as modules][]. -- It treats `.json` as JSON text files. -- `.node` files are interpreted as compiled addon modules loaded with +* It treats `.json` as JSON text files. +* `.node` files are interpreted as compiled addon modules loaded with `process.dlopen()`. -- It treats all files that lack `.json` or `.node` extensions as JavaScript +* It treats all files that lack `.json` or `.node` extensions as JavaScript text files. -- It can only be used to [load ECMAScript modules from CommonJS modules][] if +* It can only be used to [load ECMAScript modules from CommonJS modules][] if the module graph is synchronous (that contains no top-level `await`). When used to load a JavaScript text file that is not an ECMAScript module, the file will be loaded as a CommonJS module. There is the ECMAScript module loader: -- It is asynchronous, unless it's being used to load modules for `require()`. -- It is responsible for handling `import` statements and `import()` expressions. -- It is not monkey patchable, can be customized using [loader hooks][]. -- It does not support folders as modules, directory indexes (e.g. +* It is asynchronous, unless it's being used to load modules for `require()`. +* It is responsible for handling `import` statements and `import()` expressions. +* It is not monkey patchable, can be customized using [loader hooks][]. +* It does not support folders as modules, directory indexes (e.g. `'./startup/index.js'`) must be fully specified. -- It does no extension searching. A file extension must be provided +* It does no extension searching. A file extension must be provided when the specifier is a relative or absolute file URL. -- It can load JSON modules, but an import type attribute is required. -- It accepts only `.js`, `.mjs`, and `.cjs` extensions for JavaScript text +* It can load JSON modules, but an import type attribute is required. +* It accepts only `.js`, `.mjs`, and `.cjs` extensions for JavaScript text files. -- It can be used to load JavaScript CommonJS modules. Such modules +* It can be used to load JavaScript CommonJS modules. Such modules are passed through the `cjs-module-lexer` to try to identify named exports, which are available if they can be determined through static analysis. Imported CommonJS modules have their URLs converted to absolute @@ -231,12 +231,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). @@ -451,8 +451,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 ./ @@ -462,9 +462,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 @@ -675,28 +675,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 @@ -811,14 +811,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 @@ -828,16 +828,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. @@ -941,15 +941,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"` @@ -966,7 +966,7 @@ changes: description: Remove the `--experimental-resolve-self` option. --> -- Type: {string} +* Type: {string} ```json { @@ -987,7 +987,7 @@ The `"name"` field can be used in addition to the [`"exports"`][] field to added: v0.4.0 --> -- Type: {string} +* Type: {string} ```json { @@ -996,7 +996,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. When a package has an [`"exports"`][] field, this will take precedence over the `"main"` field when importing the package by name. @@ -1021,7 +1021,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. @@ -1032,7 +1032,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 @@ -1094,7 +1094,7 @@ changes: description: Implement conditional exports. --> -- Type: {Object|string|string\[]} +* Type: {Object|string|string\[]} ```json { @@ -1123,7 +1123,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 f08bd86792355b..3302c3577b0934 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 f7f45d57d927ce..016c69d0577e9f 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 d47a0413446acd..867048aa8af732 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 c120bb25efff29..fc394a73fbdb7a 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 14f33fd26a1f3e..db615e793be653 100644 --- a/doc/api/sqlite.md +++ b/doc/api/sqlite.md @@ -2,6 +2,8 @@ + + diff --git a/doc/api/string_decoder.md b/doc/api/string_decoder.md index 5d848cfb6d550b..483ebcf543dac9 100644 --- a/doc/api/string_decoder.md +++ b/doc/api/string_decoder.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable diff --git a/doc/api/test.md b/doc/api/test.md index 67af2b8fc8d3a9..1303834da7f4ba 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 a7c4c3a48d8707..b265da15dec06b 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 ce6e1bd2434942..fcb58623ea1854 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 90f8a815d26898..b17278ee731d0b 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 daa6f7be818714..78e66d8f89523d 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -2,6 +2,8 @@ + + > Stability: 2 - Stable From 6a5b2fcecca33d3feb50829396e86b560852abd8 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 | 6 +++++- doc/api/url.md | 5 ++++- doc/api/v8.md | 6 +++++- doc/api/worker_threads.md | 8 ++++++-- 29 files changed, 150 insertions(+), 31 deletions(-) diff --git a/doc/api/async_context.md b/doc/api/async_context.md index 569d89f301ec4c..f63e23d40959b1 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 9095c5ff5ffca5..782f3663115a95 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 e09580547401fc..fda00bd0752633 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 6d52c54b47b720..11a2edc2fde877 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 12b4a3d5edb959..4c6bb74c797271 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 b5ce57b9aacf0c..1f57cc4c919cdd 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 d9983e2cd02a51..4e390a542f05f5 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 769ac727c6e432..a797fea85cf667 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 1c34d581c75246..213f468bf8439e 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 5e70c0ebd907e2..6c70bf2d1379bf 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 5e07867d2a40d8..2bbb655f3e3a34 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 cbf110076dacf7..a2033c6fad711e 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 23994f63c8f488..23ab8dd9db010a 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 d5ca74fda54830..e1c406bd904d5e 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 64fa59d3e087f5..beee5ecbab4d5c 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 016c69d0577e9f..d9d2e038e7175a 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 fc394a73fbdb7a..05e2d84dcd4187 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 db615e793be653..135ca8613f53e4 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 f335eed41390f2..7ebf4d6eae3d67 100644 --- a/doc/api/synopsis.md +++ b/doc/api/synopsis.md @@ -1,6 +1,10 @@ # Usage and example - + ## Usage diff --git a/doc/api/test.md b/doc/api/test.md index 1303834da7f4ba..dc1755f37615b1 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 b265da15dec06b..e4bb460b9ca5cb 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 763581ed31646a..d6ad490ec95a0f 100644 --- a/doc/api/typescript.md +++ b/doc/api/typescript.md @@ -15,7 +15,11 @@ changes: - + > Stability: 1.2 - Release candidate diff --git a/doc/api/url.md b/doc/api/url.md index fcb58623ea1854..d6ea4aaf502e85 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 b17278ee731d0b..b1a776918f16bb 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 78e66d8f89523d..ded7c61cbc0882 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -2,8 +2,12 @@ - - + > Stability: 2 - Stable From a0c9df0ca0c2695dcf4d6cb3760964fcca9040e4 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 05e2d84dcd4187..057d714b7fe700 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 ded7c61cbc0882..d1d55dbeb1f820 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 de7001c95bed8fb5a63731035839456b9781e900 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 f63e23d40959b1..845aab6c15c8a6 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 4c6bb74c797271..c28335f5e08e12 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 1f57cc4c919cdd..7e3cdc216d39cd 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 a797fea85cf667..385ac167b37d61 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 213f468bf8439e..9281a3d1a5fe17 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 6c70bf2d1379bf..454ef768eb71a7 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 2bbb655f3e3a34..9d85da73b79183 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 df932b3f9ff02d..68dd6ffb43142b 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 31beec4e9f9b1f..b8f9a7ec34bea2 100644 --- a/doc/api/index.md +++ b/doc/api/index.md @@ -5,7 +5,7 @@ - + * [About this documentation](documentation.md) * [Usage and example](synopsis.md) diff --git a/doc/api/inspector.md b/doc/api/inspector.md index a2033c6fad711e..7e4b9e1676aa2f 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 23ab8dd9db010a..c6a450913fc56b 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 e1c406bd904d5e..0eea87812f0ceb 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 d9d2e038e7175a..85f3f847c59b78 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 867048aa8af732..502497e10cc952 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 135ca8613f53e4..3dbb122d75f2b8 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 7ebf4d6eae3d67..4cdb626045b8d4 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 dc1755f37615b1..31ad3925774231 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 e4bb460b9ca5cb..23ab9e49246f7b 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 d6ad490ec95a0f..1a86d092dc4ff3 100644 --- a/doc/api/typescript.md +++ b/doc/api/typescript.md @@ -16,7 +16,7 @@ changes: diff --git a/doc/api/url.md b/doc/api/url.md index d6ea4aaf502e85..9935564218bd90 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 b1a776918f16bb..ace5feb9f16810 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 d1d55dbeb1f820..117dda51389806 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 b8f9a7ec34bea2..e1b75e84495806 100644 --- a/doc/api/index.md +++ b/doc/api/index.md @@ -5,7 +5,7 @@ - + * [About this documentation](documentation.md) * [Usage and example](synopsis.md) diff --git a/doc/api/quic.md b/doc/api/quic.md index 502497e10cc952..a3f6d61ba776c4 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 c28335f5e08e12..4c6bb74c797271 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 7e3cdc216d39cd..1f57cc4c919cdd 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 385ac167b37d61..a797fea85cf667 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 9281a3d1a5fe17..213f468bf8439e 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 454ef768eb71a7..6c70bf2d1379bf 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 9d85da73b79183..2bbb655f3e3a34 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 003f9aef46c30f..93b94fdeeaf72f 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 e1b75e84495806..ab0f9259974fa9 100644 --- a/doc/api/index.md +++ b/doc/api/index.md @@ -5,7 +5,7 @@ - + * [About this documentation](documentation.md) * [Usage and example](synopsis.md) diff --git a/doc/api/inspector.md b/doc/api/inspector.md index 7e4b9e1676aa2f..a2033c6fad711e 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 c6a450913fc56b..23ab8dd9db010a 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 0eea87812f0ceb..e1c406bd904d5e 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 85f3f847c59b78..d9d2e038e7175a 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 a3f6d61ba776c4..9c014ddd4bea1b 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 3dbb122d75f2b8..135ca8613f53e4 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 4cdb626045b8d4..7ebf4d6eae3d67 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 31ad3925774231..dc1755f37615b1 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 23ab9e49246f7b..e4bb460b9ca5cb 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 1a86d092dc4ff3..d6ad490ec95a0f 100644 --- a/doc/api/typescript.md +++ b/doc/api/typescript.md @@ -16,7 +16,7 @@ changes: diff --git a/doc/api/url.md b/doc/api/url.md index 9935564218bd90..d6ea4aaf502e85 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 ace5feb9f16810..b1a776918f16bb 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 117dda51389806..d1d55dbeb1f820 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -3,7 +3,7 @@