Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[v14.x backport] doc: refactor fs docs structure #39706

Closed
wants to merge 6 commits into from
Closed

[v14.x backport] doc: refactor fs docs structure #39706

wants to merge 6 commits into from

Commits on Sep 1, 2021

  1. squash: make fs.md identical to master

    @targos
    targos committed Sep 1, 2021
    Configuration menu
    Copy the full SHA
    2ed0c3f View commit details
    Browse the repository at this point in the history

  2. squash: restore lost changes entry in dgram.md

    @targos
    targos committed Sep 1, 2021
    Configuration menu
    Copy the full SHA
    136c98d View commit details
    Browse the repository at this point in the history

  3. doc: refactor fs docs structure 

    * 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: nodejs#37170
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
    @jasnell @targos
    jasnell authored and targos committed Sep 1, 2021
    Configuration menu
    Copy the full SHA
    6a5c4c5 View commit details
    Browse the repository at this point in the history

  4. squash: revert bad changes from d963269

    @targos
    targos committed Sep 1, 2021
    Configuration menu
    Copy the full SHA
    29dafe9 View commit details
    Browse the repository at this point in the history

  5. doc: change lang info string in fs JS snippets 

    Refs: nodejs/remark-preset-lint-node#176

PR-URL: nodejs#37605
Refs: nodejs#37162
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Danielle Adams <adamzdanielle@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
    @aduh95 @targos
    aduh95 authored and targos committed Sep 1, 2021
    Configuration menu
    Copy the full SHA
    e912108 View commit details
    Browse the repository at this point in the history

  6. Apply suggestions from code review 

    Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
    @targos @aduh95
    targos and aduh95 committed Sep 1, 2021
    Configuration menu
    Copy the full SHA
    2f751eb View commit details
    Browse the repository at this point in the history