smallsolar
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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 <mdawson@devrus.com>

PR-URL: https://github.com/nodejs/node/pull/42274
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
This commit is contained in:
Michael Dawson 2022-03-09 17:33:20 -05:00
parent 1134d8faf8
commit 184af1c977
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/README.md
View File

@ -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>)