Update searching-for-and-choosing-packages-to-download.mdx #1453
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
monishcm
commented
Jan 23, 2025
monishcm
commented
- Add details to search docs intro to brief about when a new package will show up in search result.
- Split provenance information to a separate documentation.
leobalter
requested changes
Jan 28, 2025
| @@ -19,61 +19,3 @@ You can use the npm search bar to find packages to use in your projects. The sea | |||
| <Screenshot src="/packages-and-modules/getting-packages-from-the-registry/search-sort-options.png" alt="Screenshot of the search Sort by dropdown featuring sorting options" /> | |||
|
|
|||
| 3. In the package search results list, click the name of the package. | |||
|
|
|||
There was a problem hiding this comment.
my concern here is that we don't have any redirect and there might be existing links today pointing out to this page. If you want to split the pages, you might keep the subtitle as is (Package provenance) and add a note the subsection moved to a new page.
| @@ -4,7 +4,7 @@ redirect_from: | |||
| - /getting-started/searching-for-packages | |||
| --- | |||
|
|
|||
| You can use the npm search bar to find packages to use in your projects. The search is performed using content from the package's title, description, readme, and keywords and is powered by [opensearch](https://opensearch.org/). Search results are displayed based on keyword matching from the package's title, description, readme, and keywords. No subjective ranking criteria are applied, except for a minimal boost to deprioritize spammy or entirely new packages, aiming to maintain a neutral stance towards all other packages. | |||
| You can use the npm search bar to locate packages for your projects. The search function leverages information from a package's title, description, readme, and keywords, powered by OpenSearch. Results are displayed based on keyword matching from these fields, without subjective ranking criteria. However, adjustments are applied to deprioritise spammy or recently published packages to ensure search neutrality. Please note that newly published packages may take up to one-two week to appear in the search results. Additionally, deprecated packages are excluded from the search results to enhance the user experience. | |||
There was a problem hiding this comment.
The original idea is appending this paragraph mentioning how long it takes for packages to show up in the search results. I'd keep the modification simplified with the intent. E.g.:
Suggested change
| You can use the npm search bar to locate packages for your projects. The search function leverages information from a package's title, description, readme, and keywords, powered by OpenSearch. Results are displayed based on keyword matching from these fields, without subjective ranking criteria. However, adjustments are applied to deprioritise spammy or recently published packages to ensure search neutrality. Please note that newly published packages may take up to one-two week to appear in the search results. Additionally, deprecated packages are excluded from the search results to enhance the user experience. | |
| You can use the npm search bar to find packages to use in your projects. The search is performed using content from the package's title, description, readme, and keywords and is powered by [opensearch](https://opensearch.org/). Search results are displayed based on keyword matching from the package's title, description, readme, and keywords. No subjective ranking criteria are applied, except for a minimal boost to deprioritize spammy or entirely new packages, aiming to maintain a neutral stance towards all other packages. | |
| Please note that newly published packages may take up to one-two week to appear in the search results. Additionally, deprecated packages are excluded from the search results to enhance the user experience. |
Here I'm just restoring the original paragraph, and adding a second paragraph with the proposed addition. The suggestion diff seems confusing because it is compared to the PR's text.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.