Improve Search Results for Docs

[bnb]

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.

Ideally, we'd:

• Have all links in search engines be the latest docs
• Allow slugs to redirect to specific versions, but not expose those to search engines
• Allow access to all historical docs from latest

[ovflowd]

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? 🤔

[bjohansebas]

Now that we have api-docs-tooling, we can generate the sitemap.xml from there and it’s not necessary to maintain it in node or here.

We would just need to reference the sitemap generated by the api-docs-tooling in this file and it would work.

If that sounds good, I can do it.

[avivkeller]

I'm closing this in favor of nodejs/api-docs-tooling#255, since there's not much we can do from this repository.