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

Links in root README go to docs.rs site with no filter. Link should include filtered results #2103

Open
gearama opened this issue Feb 11, 2025 · 5 comments
Assignees
Labels
Milestone

Comments

@gearama
Copy link
Member

gearama commented Feb 11, 2025

How is this relevant to the SDK?

Need help?
For reference documentation visit docs.rs.

Image

@github-project-automation github-project-automation bot moved this to Untriaged in Azure SDK Rust Feb 11, 2025
@github-actions github-actions bot added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Feb 11, 2025
@RickWinter RickWinter added Docs and removed needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Feb 14, 2025
@RickWinter RickWinter added this to the 2025-04 milestone Feb 14, 2025
@heaths
Copy link
Member

heaths commented Feb 14, 2025

That's where all our crates go. Where did you find this? If it's in the top-level docs, we can't link to a specific crate for any crate. You can search for crates from that site, though, just like on npmjs.org, nuget.org, etc. Each crates' README will have a specific link (they do already).

Please clarify in the bug details where you saw this so we can triage appropriately.

@ronniegeraghty
Copy link
Member

Searching the repo the Docs.rs homepage link appears in our root README.md twice.
Line 3
Line 40

Since this is in the root README.md it's not really tied to a specific crate. Is there a way to curate a list of crate docs on the site like we do for azure crates on crates.io?

Maybe if the "crates as namespaces" feature lands we can switch this to be the Docs.rs link for the azure crate.

In the meantime, is it better to leave as a link to the Docs.rs homepage or maybe link to azure_core's docs?

My thought is that most people will be using a specific service crate and not using core directly so linking them to core would just mean that have to go back to the homepage then search the crate they are working with.

@RickWinter
Copy link
Member

RickWinter commented Feb 14, 2025

We could have the link go to azure_ so the results are our crates. Unfortunately right now the results are mostly all Previous Version crates.

https://docs.rs/search?q=azure_

@RickWinter RickWinter changed the title Relevance issue Links in root README go to docs.rs site with no filter. Link should include filtered results Feb 14, 2025
@ronniegeraghty
Copy link
Member

This would be the link syntax: https://docs.rs/releases/search?query=azure_
The only issue is this shows a lot of crates that are not ours.

Image

@heaths
Copy link
Member

heaths commented Feb 14, 2025

That shows way too many crates that aren't us, or that we don't support (track 1s). Let's just remove the generic links to https://docs.rs and keep the specific one in the crates' READMEs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Untriaged
Development

No branches or pull requests

4 participants