From 7be726f86ab6a70aa4542e30865f20c53c761842 Mon Sep 17 00:00:00 2001 From: Sequoia McDowell Date: Fri, 8 Jan 2016 13:32:50 -0500 Subject: [PATCH] doc: add info to docs on how to submit docs patch The docs mentioned that the docs source live in the node source, but did not link to same. PR-URL: https://github.com/nodejs/node/pull/4591 Reviewed-By: Roman Reiss Reviewed-By: James M Snell --- doc/api/documentation.markdown | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/api/documentation.markdown b/doc/api/documentation.markdown index 0eb9eb9dbd9800..4d357e39efab37 100644 --- a/doc/api/documentation.markdown +++ b/doc/api/documentation.markdown @@ -20,6 +20,10 @@ Every `.html` and `.json` file is generated based on the corresponding documentation is generated using the `tools/doc/generate.js` program. The HTML template is located at `doc/template.html`. + +If you find a error in this documentation, please [submit an issue][] +or see [the contributing guide][] for directions on how to submit a patch. + ## Stability Index @@ -82,3 +86,6 @@ Most Unix syscalls have Windows equivalents, but behavior may differ on Windows relative to Linux and OS X. For an example of the subtle ways in which it's sometimes impossible to replace Unix syscall semantics on Windows, see [Node issue 4760](https://github.com/nodejs/node/issues/4760). + +[submit an issue]: https://github.com/nodejs/node/issues/new +[the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md