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.

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

Browsing through node.js docs should be made easy #47871

Closed
rushabhT3 opened this issue May 5, 2023 · 3 comments
Closed

Browsing through node.js docs should be made easy #47871

rushabhT3 opened this issue May 5, 2023 · 3 comments
Labels
doc Issues and PRs related to the documentations. feature request Issues that request new features to be added to Node.js.

Comments

@rushabhT3
Copy link

What is the problem this feature will solve?

Going through the docs is already a hectic task. It can be made easy with some features.

What is the feature you are proposing to solve the problem?

Search bar in the docs to go directly to the function, or related keyword.
And the site map should be present on the node.js site, especially for docs if possible also there should be a search bar on that site map.

What alternatives have you considered?

Google search directly to take me to the function directly or the chatGpt to give me the function like that directly but it becomes hard when you don't know the basics.

@rushabhT3 rushabhT3 added the feature request Issues that request new features to be added to Node.js. label May 5, 2023
@github-project-automation github-project-automation bot moved this to Pending Triage in Node.js feature requests May 5, 2023
@VoltrexKeyva VoltrexKeyva added the doc Issues and PRs related to the documentations. label May 5, 2023
@bnoordhuis
Copy link
Member

Admins, this should probably be moved to nodejs/website?

@tniessen
Copy link
Member

tniessen commented May 5, 2023

The docs themselves as well as the HTML generation are maintained in this repo, but I think the ongoing website redesign will render the docs in its own way and maybe even add server-side search once the Next.js website is hosted at Cloudflare/Vercel/literally any company that supports Next.js, assuming that can be done without vendor lock-in. That hopefully won't affect the core repo though.

I'll close this in favor of nodejs/admin#766 and various discussions in https://github.com/nodejs/nodejs.org. cc @ovflowd

@tniessen tniessen closed this as not planned Won't fix, can't repro, duplicate, stale May 5, 2023
@ovflowd
Copy link
Member

ovflowd commented May 5, 2023

As @tniessen mentioned, there are already a lot of efforts happening right now for improving the docs experience.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. feature request Issues that request new features to be added to Node.js.
Projects
None yet
Development

No branches or pull requests

5 participants