nodejs / nodejs.org

The Node.js® Website
https://nodejs.org
MIT License
6.14k stars 6.21k forks source link

Improve Search Results for Docs #6577

Open bnb opened 6 months ago

bnb commented 6 months ago

Enter your suggestions in details:

Currently, you can search on Google for a Node.js API and get extremely outdated documentation with no path to reach the current docs. I just searched "node fs readfile" on Google to get the docs page, and the top result is Node.js v6 docs, which somehow do have more recent docs in the dropdown but not the most recent docs - the latest available are v9 docs.

I think having the historical docs is extremely important, but IMO this is an extremely suboptimal experience that can very easily confuse users and be deeply frustrating.

image

Ideally, we'd:

ovflowd commented 6 months ago

The issue is that API docs have no sitemap.xml and their pages are not correctly indexed. I'm not sure this should be under this repository or node/node since that's where the API docs live.

Ideally, we'd:

I'm not sure where you're suggesting these things to be added? 🤔