Skip to content

Fix: improve formatting and descriptions in docs index #8009

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.

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

Merged
merged 1 commit into from
Jul 24, 2025

Conversation

nitin-is-me
Copy link
Contributor

@nitin-is-me nitin-is-me commented Jul 22, 2025

Description

Improved the README.md documentation index file by:

  • Adding a missing description for the "Code of Conduct" link
  • Making formatting consistent by bolding all resource link titles

Validation

No code was changed. This is a markdown-only update to improve contributor-facing documentation.

Reviewers can check the README.md visually to confirm:

  • All list items are bolded consistently
  • The "Code of Conduct" line now includes a clear description

Related Issues

N/A

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run pnpm format to ensure the code follows the style guide.
  • I have run pnpm test to check if all tests are passing. (N/A)
  • I have run pnpm build to check if the website builds without errors. (N/A)
  • I've covered new added functionality with unit tests if necessary. (N/A)

@nitin-is-me nitin-is-me requested review from a team as code owners July 22, 2025 14:02
Copy link

vercel bot commented Jul 22, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nodejs-org ✅ Ready (Inspect) Visit Preview Jul 22, 2025 2:03pm

@nitin-is-me
Copy link
Contributor Author

Hey all, thanks for the reviews! Looks like it's just waiting on workflow approval now, just flagging in case it got missed.

@AugustinMauroy
Copy link
Member

Hey all, thanks for the reviews! Looks like it's just waiting on workflow approval now, just flagging in case it got missed.

In our contribution guideline we need to wait 48h without objections then trigger ci and merge ✨

@nitin-is-me
Copy link
Contributor Author

nitin-is-me commented Jul 23, 2025

Hey all, thanks for the reviews! Looks like it's just waiting on workflow approval now, just flagging in case it got missed.

In our contribution guideline we need to wait 48h without objections then trigger ci and merge ✨

Ahh got it, I wasn’t aware of the 48h rule. Thanks for the heads up! Appreciate the clarity. Looking forward to it running through!

Copy link

codecov bot commented Jul 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.00%. Comparing base (2a2aa16) to head (0da6495).
Report is 7 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8009      +/-   ##
==========================================
+ Coverage   72.99%   73.00%   +0.01%     
==========================================
  Files          95       95              
  Lines        8317     8317              
  Branches      214      214              
==========================================
+ Hits         6071     6072       +1     
+ Misses       2245     2244       -1     
  Partials        1        1              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mikeesto mikeesto added the github_actions:pull-request Trigger Pull Request Checks label Jul 24, 2025
@github-actions github-actions bot removed the github_actions:pull-request Trigger Pull Request Checks label Jul 24, 2025
Copy link
Contributor

github-actions bot commented Jul 24, 2025

Lighthouse Results

URL Performance Accessibility Best Practices SEO Report
/en 🟢 91 🟢 100 🟢 100 🔴 66 🔗
/en/about 🟢 100 🟢 97 🟢 100 🔴 58 🔗
/en/about/previous-releases 🟢 99 🟢 93 🟢 100 🔴 61 🔗
/en/download 🟢 96 🟢 100 🟢 100 🔴 66 🔗
/en/blog 🟢 100 🟢 100 🟢 96 🔴 69 🔗

Copy link
Member

@mikeesto mikeesto left a comment

Choose a reason for hiding this comment

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

Thanks @nitin-is-me

@mikeesto mikeesto added this pull request to the merge queue Jul 24, 2025
Merged via the queue into nodejs:main with commit 25c3f61 Jul 24, 2025
14 checks passed
@nitin-is-me
Copy link
Contributor Author

Thanks @nitin-is-me

Glad to contribute!

@nitin-is-me nitin-is-me deleted the fix/docs-readme-consistency branch July 25, 2025 00:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants