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

Improve Search Results for Docs #6577

Open
bnb opened this issue Mar 28, 2024 · 1 comment
Open

Improve Search Results for Docs #6577

bnb opened this issue Mar 28, 2024 · 1 comment

Comments

@bnb
Copy link
Contributor

bnb commented Mar 28, 2024

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:

  • 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
Copy link
Member

ovflowd commented Mar 29, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants