Skip to content

Commit db7f2e6

Browse files
committed
meta: fixed some api docs links
1 parent 98744ef commit db7f2e6

File tree

14 files changed

+33
-33
lines changed

14 files changed

+33
-33
lines changed

pages/en/blog/release/v20.6.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ This feature was contributed by Antoine du Hamel in <https://github.com/nodejs/n
5353

5454
#### Node.js C++ addons now have experimental support for cppgc (Oilpan), a C++ garbage collection library in V8.
5555

56-
Now when Node.js starts up, it makes sure that there is a `v8::CppHeap` attached to the V8 isolate. This enables users to allocate in the `v8::CppHeap` using `<cppgc/*>` headers from V8, which are now also included into the Node.js headers available to addons. Note that since Node.js only bundles the cppgc library coming from V8, [the ABI stability](https://nodejs.org/docs/guides/abi-stability#abi-stability-in-nodejs) of cppgc is currently not guaranteed in semver-minor and -patch updates, but we do not expect the ABI to break often, as it has been stable and battle-tested in Chromium for years. We may consider including cppgc into the ABI stability guarantees when it gets enough adoption internally and externally.
56+
Now when Node.js starts up, it makes sure that there is a `v8::CppHeap` attached to the V8 isolate. This enables users to allocate in the `v8::CppHeap` using `<cppgc/*>` headers from V8, which are now also included into the Node.js headers available to addons. Note that since Node.js only bundles the cppgc library coming from V8, [the ABI stability](/docs/guides/abi-stability#abi-stability-in-nodejs) of cppgc is currently not guaranteed in semver-minor and -patch updates, but we do not expect the ABI to break often, as it has been stable and battle-tested in Chromium for years. We may consider including cppgc into the ABI stability guarantees when it gets enough adoption internally and externally.
5757

5858
To help addon authors create JavaScript-to-C++ references of which V8's garbage collector can be aware, a helper function [`node::SetCppgcReference(isolate, js_object, cppgc_object)`](https://github.com/nodejs/node/blob/v20.6.0/test/addons/cppgc-object/binding.cc) has been added to `node.h`. V8 may provide a native alternative in the future, which could then replace this Node.js-specific helper. In the mean time, users can use this API to avoid having to hard-code the layout of JavaScript wrapper objects. An example of how to create garbage-collected C++ objects in the unified heap and wrap it in a JavaScript object can be found in the [Node.js addon tests](https://github.com/nodejs/node/blob/v20.6.0/test/addons/cppgc-object/binding.cc).
5959

pages/en/blog/release/v8.0.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ as well.
5252
The [N-API](https://nodejs.org/api/n-api.html) is experimental in Node.js 8.0.0,
5353
so significant changes in the implementation and API should be expected. Native
5454
addon developers are
55-
[encouraged to begin working with the API](https://nodejs.org/docs/guides/publishing-napi-modules/)
55+
[encouraged to begin working with the API](/docs/guides/publishing-napi-modules/)
5656
as soon as possible and to provide feedback that will be necessary to ensure
5757
that the new API meets the needs of the ecosystem.
5858

pages/en/docs/guides/diagnostics/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ root-cause their issues.
1515

1616
This is the available set of diagnostics guides:
1717

18-
- [Memory](https://nodejs.org/docs/guides/diagnostics/memory)
19-
- [Live Debugging](https://nodejs.org/docs/guides/diagnostics/live-debugging)
20-
- [Poor Performance](https://nodejs.org/docs/guides/diagnostics/poor-performance)
18+
- [Memory](/docs/guides/diagnostics/memory)
19+
- [Live Debugging](/docs/guides/diagnostics/live-debugging)
20+
- [Poor Performance](/docs/guides/diagnostics/poor-performance)
2121

2222
[Diagnostics Working Group]: https://github.com/nodejs/diagnostics

pages/en/docs/guides/diagnostics/live-debugging/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ application executes for a certain trigger like an incoming HTTP request. They
2828
may also want to step through the code and control the execution as well as
2929
inspect what values variables hold in memory.
3030

31-
- [Using Inspector](https://nodejs.org/docs/guides/diagnostics/live-debugging/using-inspector)
31+
- [Using Inspector](/docs/guides/diagnostics/live-debugging/using-inspector)

pages/en/docs/guides/diagnostics/memory/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,6 @@ type of objects take and what variables are preventing them from being garbage
5858
collected. It can also help to know the allocation pattern of our program over
5959
time.
6060

61-
- [Using Heap Profiler](https://nodejs.org/docs/guides/diagnostics/memory/using-heap-profiler/)
62-
- [Using Heap Snapshot](https://nodejs.org/docs/guides/diagnostics/memory/using-heap-snapshot/)
63-
- [GC Traces](https://nodejs.org/docs/guides/diagnostics/memory/using-gc-traces)
61+
- [Using Heap Profiler](/docs/guides/diagnostics/memory/using-heap-profiler/)
62+
- [Using Heap Snapshot](/docs/guides/diagnostics/memory/using-heap-snapshot/)
63+
- [GC Traces](/docs/guides/diagnostics/memory/using-gc-traces)

pages/en/docs/guides/diagnostics/poor-performance/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@ the others. When we do this locally, we usually try to optimize our code.
3232

3333
This document provides two simple ways to profile a Node.js application:
3434

35-
- [Using V8 Sampling Profiler](https://nodejs.org/docs/guides/simple-profiling/)
36-
- [Using Linux Perf](https://nodejs.org/docs/guides/diagnostics/poor-performance/using-linux-perf)
35+
- [Using V8 Sampling Profiler](/docs/guides/simple-profiling/)
36+
- [Using Linux Perf](/docs/guides/diagnostics/poor-performance/using-linux-perf)

pages/en/docs/guides/diagnostics/poor-performance/using-linux-perf.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,11 @@ visualization.
7272

7373
![Example nodejs flamegraph](https://user-images.githubusercontent.com/26234614/129488674-8fc80fd5-549e-4a80-8ce2-2ba6be20f8e8.png)
7474

75-
To generate a flamegraph from this result, follow [this tutorial](https://nodejs.org/docs/guides/diagnostics-flamegraph/#create-a-flame-graph-with-system-perf-tools)
75+
To generate a flamegraph from this result, follow [this tutorial](/docs/guides/diagnostics-flamegraph/#create-a-flame-graph-with-system-perf-tools)
7676
from step 6.
7777

7878
Because `perf` output is not a Node.js specific tool, it might have issues with how JavaScript code is optimized in
79-
Node.js. See [perf output issues](https://nodejs.org/docs/guides/diagnostics-flamegraph/#perf-output-issues) for a
79+
Node.js. See [perf output issues](/docs/guides/diagnostics-flamegraph/#perf-output-issues) for a
8080
futher reference.
8181

8282
## Useful Links

pages/en/docs/guides/index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,21 @@ layout: docs.hbs
77

88
## General
99

10-
- [Debugging - Getting Started](https://nodejs.org/docs/guides/debugging-getting-started/)
11-
- [Easy profiling for Node.js Applications](https://nodejs.org/docs/guides/simple-profiling/)
12-
- [Diagnostics - Flame Graphs](https://nodejs.org/docs/guides/diagnostics-flamegraph/)
13-
- [Diagnostics - User Journey](https://nodejs.org/docs/guides/diagnostics/)
14-
- [Security Best Practices](https://nodejs.org/docs/guides/security/)
10+
- [Debugging - Getting Started](/docs/guides/debugging-getting-started/)
11+
- [Easy profiling for Node.js Applications](/docs/guides/simple-profiling/)
12+
- [Diagnostics - Flame Graphs](/docs/guides/diagnostics-flamegraph/)
13+
- [Diagnostics - User Journey](/docs/guides/diagnostics/)
14+
- [Security Best Practices](/docs/guides/security/)
1515

1616
## Node.js core concepts
1717

18-
- [The Node.js Event Loop, Timers, and `process.nextTick()`](https://nodejs.org/docs/guides/event-loop-timers-and-nexttick/)
19-
- [Don't Block the Event Loop (or the Worker Pool)](https://nodejs.org/docs/guides/dont-block-the-event-loop/)
18+
- [The Node.js Event Loop, Timers, and `process.nextTick()`](/docs/guides/event-loop-timers-and-nexttick/)
19+
- [Don't Block the Event Loop (or the Worker Pool)](/docs/guides/dont-block-the-event-loop/)
2020

2121
## Module-related guides
2222

23-
- [Anatomy of an HTTP Transaction](https://nodejs.org/docs/guides/anatomy-of-an-http-transaction/)
24-
- [Working with Different Filesystems](https://nodejs.org/docs/guides/working-with-different-filesystems/)
25-
- [Backpressuring in Streams](https://nodejs.org/docs/guides/backpressuring-in-streams/)
26-
- [How to publish N-API package](https://nodejs.org/docs/guides/publishing-napi-modules/)
27-
- [ABI Stability](https://nodejs.org/docs/guides/abi-stability/)
23+
- [Anatomy of an HTTP Transaction](/docs/guides/anatomy-of-an-http-transaction/)
24+
- [Working with Different Filesystems](/docs/guides/working-with-different-filesystems/)
25+
- [Backpressuring in Streams](/docs/guides/backpressuring-in-streams/)
26+
- [How to publish N-API package](/docs/guides/publishing-napi-modules/)
27+
- [ABI Stability](/docs/guides/abi-stability/)

pages/en/learn/asynchronous-work/the-nodejs-event-emitter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ authors: flaviocopes, MylesBorins, fhemberger, LaRuaNa, ahmadawais, ovflowd
88

99
If you worked with JavaScript in the browser, you know how much of the interaction of the user is handled through events: mouse clicks, keyboard button presses, reacting to mouse movements, and so on.
1010

11-
On the backend side, Node.js offers us the option to build a similar system using the [`events` module](https://nodejs.org/api/events/).
11+
On the backend side, Node.js offers us the option to build a similar system using the [`events` module](https://nodejs.org/api/events.html).
1212

1313
This module, in particular, offers the `EventEmitter` class, which we'll use to handle our events.
1414

@@ -67,4 +67,4 @@ The EventEmitter object also exposes several other methods to interact with even
6767
- `removeListener()` / `off()`: remove an event listener from an event
6868
- `removeAllListeners()`: remove all listeners for an event
6969

70-
You can read more about these methods in the [official documentation](https://nodejs.org/api/events/).
70+
You can read more about these methods in the [official documentation](https://nodejs.org/api/events.html).

pages/en/learn/command-line/how-to-use-the-nodejs-repl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,4 +149,4 @@ local.on('exit', () => {
149149
});
150150
```
151151

152-
You can read more about the REPL module in the [repl documentation](https://nodejs.org/api/repl/).
152+
You can read more about the REPL module in the [repl documentation](https://nodejs.org/api/repl.html).

0 commit comments

Comments
 (0)