search

NomicFoundation / hardhat

Hardhat is a development environment to compile, deploy, test, and debug your Ethereum software.
https://hardhat.org
Other
7.23k stars 1.39k forks source link

hardhat.org search doesn't search plugin docs #1796

Open aspiers opened 3 years ago

aspiers commented 3 years ago

For example if I enter getNamedAccounts in the search box on https://hardhat.org/, I get no matches:

image

I assume this is because it is only documented in a third-party plugin:

https://hardhat.org/plugins/hardhat-deploy.html

However the fact that the documentation of this third-party plugin is visible from hardhat.org naturally leads users to reasonably expect that searching for terms like getNamedAccounts via hardhat.org's search box would show the results from that documentation, and the fact that it doesn't is both confusing and inconvenient.

I guess there are probably some technical challenges in getting the search to index third-party plugin docs, but it would be awesome if that could be fixed!

fvictorio commented 3 years ago

However the fact that the documentation of this third-party plugin is visible from hardhat.org naturally leads users to reasonably expect that searching for terms like getNamedAccounts via hardhat.org's search box would show the results from that documentation, and the fact that it doesn't is both confusing and inconvenient.

I think this is the core of the problem, and something we want to stop doing. Having third-party plugins READMEs as part of the site is problematic for several reasons, and this is another good one. So the "fix" will probably be just removing them and redirecting users to the repository.

That being said, it seems like our plugins aren't indexed either? So that's something we might want to fix.

alcuadrado commented 2 years ago

I believe #1985 will lead to our plugins being indexed.

Community plugins' docs will no longer be displayed on our site once that PR is merged.

alcuadrado commented 2 years ago

I believe #1985 will lead to our plugins being indexed.

Actually, we may need to get algolia to remove this line: https://github.com/algolia/docsearch-configs/blob/master/configs/hardhat.json#L7

github-actions[bot] commented 2 years ago

This issue was marked as stale because it didn't have any activity in the last 30 days. If you think it's still relevant, please leave a comment indicating so. Otherwise, it will be closed in 7 days.

fvictorio commented 1 year ago

This is still relevant because, although community plugins docs are no longer part of our site, the search still doesn't seem to work for our own plugins.