Skip to content

Commit 4e9b657

Browse files
committed
doc: improve llm.txt descriptions
1 parent 0869525 commit 4e9b657

27 files changed

+118
-66
lines changed

doc/api/async_hooks.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
<!--introduced_in=v8.1.0-->
44

5+
<!-- 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. -->
6+
57
> Stability: 1 - Experimental. Please migrate away from this API, if you can.
68
> We do not recommend using the [`createHook`][], [`AsyncHook`][], and
79
> [`executionAsyncResource`][] APIs as they have usability issues, safety risks,

doc/api/cluster.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
<!--introduced_in=v0.10.0-->
44

5+
<!-- 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. -->
6+
57
> Stability: 2 - Stable
68
79
<!-- source_link=lib/cluster.js -->

doc/api/debugger.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
<!--introduced_in=v0.9.12-->
44

5+
<!-- llm_description=Provides a CLI interface for debugging Node.js applications, including basic stepping and inspection. -->
6+
57
> Stability: 2 - Stable
68
79
<!-- type=misc -->

doc/api/deprecations.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
<!--introduced_in=v7.7.0-->
44

5+
<!-- llm_description=Lists APIs that are deprecated and subject to removal in future releases. -->
6+
57
<!-- type=misc -->
68

79
Node.js APIs might be deprecated for any of the following reasons:

doc/api/diagnostics_channel.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ changes:
1414

1515
<!--introduced_in=v15.1.0-->
1616

17+
<!-- 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. -->
18+
1719
> Stability: 2 - Stable
1820
1921
<!-- source_link=lib/diagnostics_channel.js -->

doc/api/domain.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ changes:
1717

1818
<!--introduced_in=v0.10.0-->
1919

20+
<!-- llm_description=Deprecated (avoid). Legacy API for error handling across async operations. -->
21+
2022
> Stability: 0 - Deprecated
2123
2224
<!-- source_link=lib/domain.js -->

doc/api/errors.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
<!--introduced_in=v4.0.0-->
44

5+
<!-- llm_description=Describes the error types in Node.js and how they are handled during execution. -->
6+
57
<!--type=misc-->
68

79
Applications running in Node.js will generally experience the following

doc/api/globals.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
<!--introduced_in=v0.10.0-->
44

5+
<!-- llm_description=Lists built-in global objects and functions available in the Node.js runtime. -->
6+
57
<!-- type=misc -->
68

79
> Stability: 2 - Stable

doc/api/http.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
<!--introduced_in=v0.10.0-->
44

5+
<!-- llm_description=Provides functionality for creating HTTP servers and clients, enabling the handling of HTTP requests and responses. -->
6+
57
> Stability: 2 - Stable
68
79
<!-- source_link=lib/http.js -->

doc/api/http2.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ changes:
1919

2020
<!--introduced_in=v8.4.0-->
2121

22+
<!-- llm_description=Enables HTTP/2 protocol support. -->
23+
2224
> Stability: 2 - Stable
2325
2426
<!-- source_link=lib/http2.js -->

0 commit comments

Comments
 (0)