doc: break long descriptions

araujogui · araujogui · commit 2f27bc36a62d · 2025-07-30T20:09:07.000-03:00
diff --git a/doc/api/async_context.md b/doc/api/async_context.md
@@ -6,7 +6,13 @@
 
 <!-- source_link=lib/async_hooks.js -->
 
-<!-- llm_description=Tracks asynchronous execution context. Enables storing and propagating state across async operations like callbacks and promises. Useful for request tracking, logging, or context management. Provides AsyncLocalStorage for scoped storage and AsyncResource for custom async context binding. -->
+<!-- YAML
+llm_description: >
+  Tracks asynchronous execution context. Enables storing and propagating state
+  across async operations like callbacks and promises. Useful for request
+  tracking, logging, or context management. Provides AsyncLocalStorage for
+  scoped storage and AsyncResource for custom async context binding.
+-->
 
 ## Introduction
 
diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md
@@ -2,7 +2,12 @@
 
 <!--introduced_in=v8.1.0-->
 
-<!-- llm_description=Low-level API to monitor asynchronous operations (timeouts, promises, callbacks). Primarily for advanced diagnostics or custom profiling tools. Avoid on production, use AsyncLocalStorage for most context-tracking needs. -->
+<!-- YAML
+llm_description: >
+  Low-level API to monitor asynchronous operations (timeouts, promises,
+  callbacks). Primarily for advanced diagnostics or custom profiling tools.
+  Avoid on production, use AsyncLocalStorage for most context-tracking needs.
+-->
 
 > 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
@@ -2,7 +2,12 @@
 
 <!--introduced_in=v0.10.0-->
 
-<!-- llm_description=Enables multi-process scaling by forking identical Node.js instances (workers) to handle loads across CPU cores. Ideal for HTTP servers needing parallelism. For lightweight concurrency, prefer worker_threads. -->
+<!-- YAML
+llm_description: >
+  Enables multi-process scaling by forking identical Node.js instances
+  (workers) to handle loads across CPU cores. Ideal for HTTP servers needing
+  parallelism. For lightweight concurrency, prefer worker_threads.
+-->
 
 > Stability: 2 - Stable
 
diff --git a/doc/api/debugger.md b/doc/api/debugger.md
@@ -2,7 +2,11 @@
 
 <!--introduced_in=v0.9.12-->
 
-<!-- llm_description=Provides a CLI interface for debugging Node.js applications, including basic stepping and inspection. -->
+<!-- YAML
+llm_description: >
+  Provides a CLI interface for debugging Node.js applications, including
+  basic stepping and inspection.
+-->
 
 > Stability: 2 - Stable
 
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
@@ -2,7 +2,10 @@
 
 <!--introduced_in=v7.7.0-->
 
-<!-- llm_description=Lists APIs that are deprecated and subject to removal in future releases. -->
+<!-- YAML
+llm_description: >
+  Lists APIs that are deprecated and subject to removal in future releases.
+-->
 
 <!-- type=misc -->
 
diff --git a/doc/api/diagnostics_channel.md b/doc/api/diagnostics_channel.md
@@ -14,7 +14,12 @@ changes:
 
 <!--introduced_in=v15.1.0-->
 
-<!-- llm_description=Publish/subscribe API for custom diagnostic events (e.g., database query metrics, HTTP request lifecycle). Integrates with APM tools or logging systems to monitor internal operations. -->
+<!-- YAML
+llm_description: >
+  Publish/subscribe API for custom diagnostic events (e.g., database query
+  metrics, HTTP request lifecycle). Integrates with APM tools or logging
+  systems to monitor internal operations.
+-->
 
 > Stability: 2 - Stable
 
diff --git a/doc/api/domain.md b/doc/api/domain.md
@@ -17,7 +17,10 @@ changes:
 
 <!--introduced_in=v0.10.0-->
 
-<!-- llm_description=Deprecated (avoid). Legacy API for error handling across async operations. -->
+<!-- YAML
+llm_description: >
+  Deprecated (avoid). Legacy API for error handling across async operations.
+-->
 
 > Stability: 0 - Deprecated
 
diff --git a/doc/api/errors.md b/doc/api/errors.md
@@ -2,7 +2,10 @@
 
 <!--introduced_in=v4.0.0-->
 
-<!-- llm_description=Describes the error types in Node.js and how they are handled during execution. -->
+<!-- YAML
+llm_description: >
+  Describes the error types in Node.js and how they are handled during execution.
+-->
 
 <!--type=misc-->
 
diff --git a/doc/api/esm.md b/doc/api/esm.md
@@ -2,7 +2,11 @@
 
 <!--introduced_in=v8.5.0-->
 
-<!-- llm_description=Provides support for ECMAScript modules in Node.js, enabling standards-based module syntax (import/export) and interoperability with CommonJS. -->
+<!-- YAML
+llm_description: >
+  Provides support for ECMAScript modules in Node.js, enabling standards-based
+  module syntax (import/export) and interoperability with CommonJS.
+-->
 
 <!-- type=misc -->
 
diff --git a/doc/api/globals.md b/doc/api/globals.md
@@ -2,7 +2,10 @@
 
 <!--introduced_in=v0.10.0-->
 
-<!-- llm_description=Lists built-in global objects and functions available in the Node.js runtime. -->
+<!-- YAML
+llm_description: >
+  Lists built-in global objects and functions available in the Node.js runtime.
+-->
 
 <!-- type=misc -->
 
diff --git a/doc/api/http.md b/doc/api/http.md
@@ -2,7 +2,11 @@
 
 <!--introduced_in=v0.10.0-->
 
-<!-- llm_description=Provides functionality for creating HTTP servers and clients, enabling the handling of HTTP requests and responses. -->
+<!-- YAML
+llm_description: >
+  Provides functionality for creating HTTP servers and clients, enabling the
+  handling of HTTP requests and responses.
+-->
 
 > Stability: 2 - Stable
 
diff --git a/doc/api/inspector.md b/doc/api/inspector.md
@@ -2,7 +2,11 @@
 
 <!--introduced_in=v8.0.0-->
 
-<!-- llm_description=Enables programmatic interaction with the V8 Inspector for debugging and profiling -->
+<!-- YAML
+llm_description: >
+  Enables programmatic interaction with the V8 Inspector for debugging and
+  profiling.
+-->
 
 > Stability: 2 - Stable
 
diff --git a/doc/api/module.md b/doc/api/module.md
@@ -2,7 +2,12 @@
 
 <!--introduced_in=v12.20.0-->
 
-<!-- llm_description=Provides utilities for interacting with Node.js modules, including support for module creation, resolution, customization hooks, and compile caching. Enables advanced module loading behavior. -->
+<!-- YAML
+llm_description: >
+  Provides utilities for interacting with Node.js modules, including support
+  for module creation, resolution, customization hooks, and compile caching.
+  Enables advanced module loading behavior.
+-->
 
 <!-- YAML
 added: v0.3.7
diff --git a/doc/api/modules.md b/doc/api/modules.md
@@ -2,7 +2,11 @@
 
 <!--introduced_in=v0.10.0-->
 
-<!-- llm_description=Node supports both CommonJS (require()) and ES Modules (import/export). Use ESM, which enables browser compatibility and top-level await. -->
+<!-- YAML
+llm_description: >
+  Node supports both CommonJS (require()) and ES Modules (import/export). Use
+  ESM, which enables browser compatibility and top-level await.
+-->
 
 > Stability: 2 - Stable
 
diff --git a/doc/api/os.md b/doc/api/os.md
@@ -2,7 +2,12 @@
 
 <!--introduced_in=v0.10.0-->
 
-<!-- llm_description=Provides cross-platform utilities for accessing operating system information, including CPU architecture, memory usage, network interfaces, user details, and system paths. -->
+<!-- YAML
+llm_description: >
+  Provides cross-platform utilities for accessing operating system information,
+  including CPU architecture, memory usage, network interfaces, user details,
+  and system paths.
+-->
 
 > Stability: 2 - Stable
 
diff --git a/doc/api/packages.md b/doc/api/packages.md
@@ -4,7 +4,12 @@
 
 <!-- type=misc -->
 
-<!-- llm_description=Defines how Node.js resolves and loads modules via fields like type, exports, and imports. Controls module format, entry points, and package encapsulation. -->
+<!-- YAML
+llm_description: >
+  Defines how Node.js resolves and loads modules via fields like type,
+  exports, and imports. Controls module format, entry points, and package
+  encapsulation.
+-->
 
 <!-- YAML
 changes:
diff --git a/doc/api/path.md b/doc/api/path.md
@@ -2,7 +2,11 @@
 
 <!--introduced_in=v0.10.0-->
 
-<!-- llm_description=Provides utilities for working with file and directory paths across different operating systems. -->
+<!-- YAML
+llm_description: >
+  Provides utilities for working with file and directory paths across
+  different operating systems.
+-->
 
 > Stability: 2 - Stable
 
diff --git a/doc/api/querystring.md b/doc/api/querystring.md
@@ -2,7 +2,11 @@
 
 <!--introduced_in=v0.1.25-->
 
-<!-- llm_description=Parses and formats URL query strings, providing fast utilities for handling key-value pairs. -->
+<!-- YAML
+llm_description: >
+  Parses and formats URL query strings, providing fast utilities for handling
+  key-value pairs.
+-->
 
 > Stability: 2 - Stable
 
diff --git a/doc/api/repl.md b/doc/api/repl.md
@@ -2,8 +2,10 @@
 
 <!--introduced_in=v0.10.0-->
 
-<!-- llm_description=Provides an interactive Read-Eval-Print-Loop (REPL) implementation. -->
-
+<!-- YAML
+llm_description: >
+  Provides an interactive Read-Eval-Print-Loop (REPL) implementation.
+-->
 > Stability: 2 - Stable
 
 <!-- source_link=lib/repl.js -->
diff --git a/doc/api/sqlite.md b/doc/api/sqlite.md
@@ -2,7 +2,12 @@
 
 <!--introduced_in=v22.5.0-->
 
-<!-- llm_description=Provides synchronous APIs for working with SQLite databases, including querying, transactions, backups, and change tracking. Enables in-process, file-based SQL storage. -->
+<!-- YAML
+llm_description: >
+  Provides synchronous APIs for working with SQLite databases, including
+  querying, transactions, backups, and change tracking. Enables in-process,
+  file-based SQL storage.
+-->
 
 <!-- YAML
 added: v22.5.0
diff --git a/doc/api/string_decoder.md b/doc/api/string_decoder.md
@@ -2,7 +2,11 @@
 
 <!--introduced_in=v0.10.0-->
 
-<!-- llm_description=Provides an API for decoding Buffer objects into strings while preserving multi-byte UTF-8 and UTF-16 characters. -->
+<!-- YAML
+llm_description: >
+  Provides an API for decoding Buffer objects into strings while preserving
+  multi-byte UTF-8 and UTF-16 characters.
+-->
 
 > Stability: 2 - Stable
 
diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md
@@ -1,6 +1,10 @@
 # Usage and example
 
-<!-- llm_description=Overview of basic Node.js usage via CLI. Illustrates how to run scripts and provides a simple web server example. -->
+<!-- YAML
+llm_description: >
+  Overview of basic Node.js usage via CLI. Illustrates how to run scripts and
+  provides a simple web server example.
+-->
 
 ## Usage
 
diff --git a/doc/api/test.md b/doc/api/test.md
@@ -2,7 +2,12 @@
 
 <!--introduced_in=v18.0.0-->
 
-<!-- llm_description=Built-in framework for writing and running JavaScript tests. It includes a command-line runner and offers comprehensive features such as mocking, snapshot testing, and code coverage analysis. -->
+<!-- YAML
+llm_description: >
+  Built-in framework for writing and running JavaScript tests. It includes a
+  command-line runner and offers comprehensive features such as mocking,
+  snapshot testing, and code coverage analysis.
+-->
 
 <!-- YAML
 added:
diff --git a/doc/api/tls.md b/doc/api/tls.md
@@ -2,7 +2,11 @@
 
 <!--introduced_in=v0.10.0-->
 
-<!-- llm_description=Implements Transport Layer Security (TLS) and Secure Socket Layer (SSL) protocols using OpenSSL. -->
+<!-- YAML
+llm_description: >
+  Implements Transport Layer Security (TLS) and Secure Socket Layer (SSL)
+  protocols using OpenSSL.
+-->
 
 > Stability: 2 - Stable
 
diff --git a/doc/api/tty.md b/doc/api/tty.md
@@ -2,7 +2,11 @@
 
 <!--introduced_in=v0.10.0-->
 
-<!-- llm_description=The tty module handles terminal (TTY) interactions, providing classes to manage readable and writable streams for terminal IO. -->
+<!-- YAML
+llm_description: >
+  The tty module handles terminal (TTY) interactions, providing classes to
+  manage readable and writable streams for terminal IO.
+-->
 
 > Stability: 2 - Stable
 
diff --git a/doc/api/typescript.md b/doc/api/typescript.md
@@ -15,7 +15,11 @@ changes:
 
 <!--introduced_in=v22.6.0-->
 
-<!-- llm_description=Provides lightweight TypeScript support in Node.js via type stripping. Enables execution of .ts files without type checking or full compiler features. -->
+<!-- YAML
+llm_description: >
+  Provides lightweight TypeScript support in Node.js via type stripping.
+  Enables execution of .ts files without type checking or full compiler features.
+-->
 
 > Stability: 1.2 - Release candidate
 
diff --git a/doc/api/url.md b/doc/api/url.md
@@ -2,7 +2,10 @@
 
 <!--introduced_in=v0.10.0-->
 
-<!-- llm_description=Provides utilities for parsing, constructing, and manipulating URLs. -->
+<!-- YAML
+llm_description: >
+  Provides utilities for parsing, constructing, and manipulating URLs.
+-->
 
 > Stability: 2 - Stable
 
diff --git a/doc/api/v8.md b/doc/api/v8.md
@@ -2,7 +2,11 @@
 
 <!--introduced_in=v4.0.0-->
 
-<!-- llm_description=Exposes APIs that are specific to the version of V8 built into the Node.js binary -->
+<!-- YAML
+llm_description: >
+  Exposes APIs that are specific to the version of V8 built into the Node.js
+  binary.
+-->
 
 <!-- source_link=lib/v8.js -->
 
diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md
@@ -2,8 +2,12 @@
 
 <!--introduced_in=v10.5.0-->
 
-<!-- llm_description=Enables the use of threads to execute JavaScript in parallel. It is most useful for performing CPU-intensive operations without blocking the main application's event loop. -->
-
+<!-- YAML
+llm_description: >
+  Enables the use of threads to execute JavaScript in parallel. It is most
+  useful for performing CPU-intensive operations without blocking the main
+  application's event loop.
+-->
 > Stability: 2 - Stable
 
 <!-- source_link=lib/worker_threads.js -->
