Skip to content

doc: add title to index#62046

Open
avivkeller wants to merge 2 commits intonodejs:mainfrom
avivkeller:title-index
Open

doc: add title to index#62046
avivkeller wants to merge 2 commits intonodejs:mainfrom
avivkeller:title-index

Conversation

@avivkeller
Copy link
Member

A title on this page is needed for the new web generator to populate the navigation.

Copilot AI review requested due to automatic review settings March 1, 2026 00:04
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Mar 1, 2026
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a visible title to the API index page so the new web documentation generator can populate navigation labels.

Changes:

  • Add a Markdown heading (β€œIndex”) at the top of doc/api/index.md.
  • Remove an outdated top-of-file comment block.

πŸ’‘ Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@avivkeller avivkeller added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 1, 2026
@avivkeller avivkeller added the commit-queue Add this label to land a pull request using GitHub Actions. label Mar 1, 2026
@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 Mar 3, 2026
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/62046
βœ”  Done loading data for nodejs/node/pull/62046
----------------------------------- PR info ------------------------------------
Title      doc: add title to index (#62046)
Author     Aviv Keller <me@aviv.sh> (@avivkeller)
Branch     avivkeller:title-index -> nodejs:main
Labels     doc, author ready
Commits    2
 - doc: add title to index
 - Update doc/api/index.md
Committers 2
 - Aviv Keller <me@aviv.sh>
 - GitHub <noreply@github.com>
PR-URL: https://github.com/nodejs/node/pull/62046
Reviewed-By: Claudio Wunder <cwunder@gnome.org>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/62046
Reviewed-By: Claudio Wunder <cwunder@gnome.org>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
--------------------------------------------------------------------------------
   β„Ή  This PR was created on Sun, 01 Mar 2026 00:04:44 GMT
   βœ”  Approvals: 3
   βœ”  - Claudio Wunder (@ovflowd): https://github.com/nodejs/node/pull/62046#pullrequestreview-3870926195
   βœ”  - Colin Ihrig (@cjihrig): https://github.com/nodejs/node/pull/62046#pullrequestreview-3872617697
   βœ”  - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/62046#pullrequestreview-3873356485
   βœ”  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 62046
From https://github.com/nodejs/node
 * branch                  refs/pull/62046/merge -> FETCH_HEAD
βœ”  Fetched commits as 88be44db0e45..01a32b25b481
--------------------------------------------------------------------------------
[main 4200e151bd] doc: add title to index
 Author: Aviv Keller <me@aviv.sh>
 Date: Sat Feb 28 19:04:03 2026 -0500
 1 file changed, 1 insertion(+), 4 deletions(-)
[main 90327586a2] Update doc/api/index.md
 Author: Aviv Keller <me@aviv.sh>
 Date: Sat Feb 28 19:10:20 2026 -0500
 1 file changed, 1 insertion(+), 1 deletion(-)
   βœ”  Patches applied
There are 2 commits in the PR. Attempting autorebase.
(node:351) [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 title to index

PR-URL: #62046
Reviewed-By: Claudio Wunder <cwunder@gnome.org>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

[detached HEAD 2f7361044b] doc: add title to index
Author: Aviv Keller <me@aviv.sh>
Date: Sat Feb 28 19:04:03 2026 -0500
1 file changed, 1 insertion(+), 4 deletions(-)
Rebasing (3/4)
Rebasing (4/4)
Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
Update doc/api/index.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
PR-URL: #62046
Reviewed-By: Claudio Wunder <cwunder@gnome.org>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

[detached HEAD 9aa0c1c963] Update doc/api/index.md
Author: Aviv Keller <me@aviv.sh>
Date: Sat Feb 28 19:10:20 2026 -0500
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/22602934631

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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants