From 78f2bb1c82f13102a0e9b46d9008a5c66dd1215f Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 20 May 2019 16:18:46 -0700 Subject: [PATCH] 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: https://github.com/nodejs/node/pull/27785 Reviewed-By: Richard Lau Reviewed-By: Ruben Bridgewater Reviewed-By: Trivikram Kamat --- doc/api/documentation.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/doc/api/documentation.md b/doc/api/documentation.md index 612b6f2dbf545b..db12442ea6ee03 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -9,13 +9,9 @@ Node.js is a JavaScript runtime built on the [V8 JavaScript engine][]. ## Contributing -If errors are found in this documentation, please [submit an issue][] -or see [the contributing guide][] for directions on how to submit a patch. +Report errors in this documentation in [the issue tracker][]. See +[the contributing guide][] for directions on how to submit pull requests. -Every file is generated based on the corresponding `.md` file in the -`doc/api/` folder in Node.js's source tree. The documentation is generated -using the `tools/doc/generate.js` program. An HTML template is located at -`doc/template.html`. ## Stability Index @@ -84,6 +80,6 @@ issue 4760](https://github.com/nodejs/node/issues/4760). [`'warning'`]: process.html#process_event_warning [`fs.open()`]: fs.html#fs_fs_open_path_flags_mode_callback [`stderr`]: process.html#process_process_stderr -[submit an issue]: https://github.com/nodejs/node/issues/new [the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md +[the issue tracker]: https://github.com/nodejs/node/issues/new [V8 JavaScript engine]: https://v8.dev/