doc: document goal to have examples

As discussed in next-10 mini-summit on documentation see minutes where next steps were discussed - https://github.com/nodejs/next-10/blob/main/meetings/2022-02-16.md and minutes from summit - https://github.com/nodejs/next-10/blob/main/meetings/2022-02-16.md Signed-off-by: Michael Dawson <[email protected]> PR-URL: #42274 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Darshan Sen <[email protected]>
nodejs · Apr 24, 2022 · 83391d1 · 83391d1
1 parent 39fb114
commit 83391d1
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/doc/README.md b/doc/README.md
@@ -35,6 +35,8 @@ this guide.
   (`[a link](http://example.com)`).
 * When documenting APIs, update the YAML comment associated with the API as
   appropriate. This is especially true when introducing or deprecating an API.
+* When documenting APIs, every function should have a usage example or
+  link to an example that uses the function.
 * For code blocks:
   * Use [language][]-aware fences. (<code>\`\`\`js</code>)