Skip to content

Commit 1a8e67c

Browse files
Trotttargos
authored andcommitted
doc: simplify contributing documentation
Remove out-of-place detail about filesystem layout and tools for generating documentation. Link to the issue tracker and the contribution guide with clear, concise sentences. PR-URL: #27785 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent e66648e commit 1a8e67c

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

doc/api/documentation.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,9 @@ Node.js is a JavaScript runtime built on the [V8 JavaScript engine][].
99

1010
## Contributing
1111

12-
If errors are found in this documentation, please [submit an issue][]
13-
or see [the contributing guide][] for directions on how to submit a patch.
12+
Report errors in this documentation in [the issue tracker][]. See
13+
[the contributing guide][] for directions on how to submit pull requests.
1414

15-
Every file is generated based on the corresponding `.md` file in the
16-
`doc/api/` folder in Node.js's source tree. The documentation is generated
17-
using the `tools/doc/generate.js` program. An HTML template is located at
18-
`doc/template.html`.
1915

2016
## Stability Index
2117

@@ -84,6 +80,6 @@ issue 4760](https://github.com/nodejs/node/issues/4760).
8480
[`'warning'`]: process.html#process_event_warning
8581
[`fs.open()`]: fs.html#fs_fs_open_path_flags_mode_callback
8682
[`stderr`]: process.html#process_process_stderr
87-
[submit an issue]: https://github.com/nodejs/node/issues/new
8883
[the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
84+
[the issue tracker]: https://github.com/nodejs/node/issues/new
8985
[V8 JavaScript engine]: https://v8.dev/

0 commit comments

Comments
 (0)