Skip to content

Commit

Permalink
doc: refactor fs docs structure
Browse files Browse the repository at this point in the history
* Convert examples to esm to help promote that pattern with users
* Make Promises APIs more prominent to help promite that pattern
* Separate callback/sync apis into distinct sections to make those
  more consistent with the Promises api
* Improve other bits and pieces

Signed-off-by: James M Snell <jasnell@gmail.com>

PR-URL: #37170
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
  • Loading branch information
jasnell authored and danielleadams committed Feb 16, 2021
1 parent facf3a5 commit 7d8fd3f
Show file tree
Hide file tree
Showing 2 changed files with 3,279 additions and 2,990 deletions.
1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ module.exports = {
{
files: [
'doc/api/esm.md',
'doc/api/fs.md',
'doc/api/module.md',
'doc/api/modules.md',
'doc/api/packages.md',
Expand Down
Loading

0 comments on commit 7d8fd3f

Please sign in to comment.