Skip to content

Commit

Permalink
doc: document goal to have examples
Browse files Browse the repository at this point in the history
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: #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>
  • Loading branch information
mhdawson authored and bengl committed Mar 21, 2022
1 parent da42ffb commit 78b858d
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>)

Expand Down

0 comments on commit 78b858d

Please sign in to comment.