Skip to content

Conversation

@Mohit-Raj-Saxena
Copy link

Adds cross-references to the File modes section from methods that use the mode parameter, improving discoverability of file permission documentation.

Changes

  • Added [File modes][] links in fsPromises.open(), fsPromises.mkdir(), and fs.mkdir() parameter documentation
  • Added [File modes]: #file-modes link reference

Motivation

Previously, developers using methods with mode parameters (like 0o666, 0o777) had to manually search for the File modes table. This change provides direct links to the relevant documentation.

Fixes #60280

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Oct 16, 2025
@Mohit-Raj-Saxena
Copy link
Author

Friendly ping @nodejs/documentation 👋

Would appreciate any feedback on this when you have a chance! Happy to make any changes if needed.

Thanks for your time!

@Mohit-Raj-Saxena
Copy link
Author

Bumping this after 3 weeks - would really appreciate any feedback! 🙂

Adds links to the File modes section from fsPromises.open(),
fsPromises.mkdir(), and fs.mkdir() to improve discoverability
of file permission documentation.
@UlisesGascon UlisesGascon added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Nov 16, 2025
@Mohit-Raj-Saxena
Copy link
Author

Thank you @UlisesGascon for the review and approval! Really appreciate the help throughout this process! 🙏

@aduh95 aduh95 added the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 23, 2025
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Nov 23, 2025
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/60286
✔  Done loading data for nodejs/node/pull/60286
----------------------------------- PR info ------------------------------------
Title      doc: add File modes cross-references in fs methods (#60286)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     Mohit-Raj-Saxena:fix-fs-docs -> nodejs:main
Labels     doc, fs, author ready
Commits    2
 - doc: add File modes cross-references in fs methods
 - doc: fix link reference ordering for File modes
Committers 1
 - Babu-Bhai-No-1 <rajmohitsaxena@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/60286
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/60286
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Thu, 16 Oct 2025 21:42:59 GMT
   ✔  Approvals: 1
   ✔  - Ulises Gascón (@UlisesGascon): https://github.com/nodejs/node/pull/60286#pullrequestreview-3470011236
   ✔  Last GitHub CI successful
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  No git cherry-pick in progress
   ✔  No git am in progress
   ✔  No git rebase in progress
--------------------------------------------------------------------------------
- Bringing origin/main up to date...
From https://github.com/nodejs/node
 * branch                  main       -> FETCH_HEAD
✔  origin/main is now up-to-date
- Downloading patch for 60286
From https://github.com/nodejs/node
 * branch                  refs/pull/60286/merge -> FETCH_HEAD
✔  Fetched commits as 189a0a71de7f..d7d155c95d80
--------------------------------------------------------------------------------
[main fa690305e3] doc: add File modes cross-references in fs methods
 Author: Babu-Bhai-No-1 <rajmohitsaxena@gmail.com>
 Date: Fri Oct 17 03:03:05 2025 +0530
 1 file changed, 7 insertions(+), 3 deletions(-)
[main c33a8ba0c4] doc: fix link reference ordering for File modes
 Author: Babu-Bhai-No-1 <rajmohitsaxena@gmail.com>
 Date: Sun Nov 9 12:48:08 2025 +0530
 1 file changed, 1 insertion(+), 1 deletion(-)
   ✔  Patches applied
There are 2 commits in the PR. Attempting autorebase.
(node:2266) [DEP0190] DeprecationWarning: Passing args to a child process with shell option true can lead to security vulnerabilities, as the arguments are not escaped, only concatenated.
(Use `node --trace-deprecation ...` to show where the warning was created)
Rebasing (2/4)
Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
doc: add File modes cross-references in fs methods

Adds links to the File modes section from fsPromises.open(),
fsPromises.mkdir(), and fs.mkdir() to improve discoverability
of file permission documentation.

PR-URL: #60286
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>

[detached HEAD 3ceb5cfb76] doc: add File modes cross-references in fs methods
Author: Babu-Bhai-No-1 <rajmohitsaxena@gmail.com>
Date: Fri Oct 17 03:03:05 2025 +0530
1 file changed, 7 insertions(+), 3 deletions(-)
Rebasing (3/4)
Rebasing (4/4)
Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
doc: fix link reference ordering for File modes

PR-URL: #60286
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>

[detached HEAD 74b853367c] doc: fix link reference ordering for File modes
Author: Babu-Bhai-No-1 <rajmohitsaxena@gmail.com>
Date: Sun Nov 9 12:48:08 2025 +0530
1 file changed, 1 insertion(+), 1 deletion(-)
Successfully rebased and updated refs/heads/main.

ℹ Add commit-queue-squash label to land the PR as one commit, or commit-queue-rebase to land as separate commits.

https://github.com/nodejs/node/actions/runs/19611966069

@hafizkapit94
Copy link

[Uploading 274275662

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-failed An error occurred while landing this pull request using GitHub Actions. doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Multiple Documentation Issues in fs and fs/promises Modules (Formatting, Consistency, and Clarity)

5 participants