You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Remove generic docs.rs links from root README (#2871)
The root README.md contained two generic links to docs.rs that pointed
to the homepage rather than Azure-specific documentation. These links
were not helpful for users trying to find documentation for Azure SDK
crates, as they would land on the generic docs.rs search page and have
to manually search for Azure crates.
The problematic links were:
- Line 5: "For consumers of the SDK, we recommend visiting
[Docs.rs](https://docs.rs/) and looking up the docs for any of libraries
in the SDK."
- Line 39: "For reference documentation visit
[docs.rs](https://docs.rs/)."
As discussed in the issue, these generic links have been removed while
preserving the specific docs.rs links in individual crate READMEs (e.g.,
`https://docs.rs/azure_identity/latest/azure_identity/`) which provide
direct access to the relevant crate documentation.
The document flow remains natural and users can still find specific
documentation through:
- Individual crate READMEs with their specific docs.rs links
- The examples directory in each crate
- GitHub Issues for questions
- StackOverflow with azure+rust tags
Fixes#2103.
<!-- START COPILOT CODING AGENT TIPS -->
---
💬 Share your feedback on Copilot coding agent for the chance to win a
$200 gift card! Click
[here](https://survey.alchemer.com/s3/8343779/Copilot-Coding-agent) to
start the survey.
---------
Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: ronniegeraghty <[email protected]>
This repository is for the active development of the Azure SDK for Rust. For consumers of the SDK, we recommend visiting [Docs.rs](https://docs.rs/) and looking up the docs for any of libraries in the SDK.
5
+
This repository is for the active development of the Azure SDK for Rust.
6
6
7
7
## Crates 📦
8
8
@@ -36,7 +36,6 @@ Building each crate should be as straight forward as `cargo build`, but check ea
36
36
37
37
## Need help?
38
38
39
-
- For reference documentation visit [docs.rs](https://docs.rs/).
40
39
- For examples, go to the `examples` subdirectory in any library's project folder e.g., `/sdk/identity/azure_identity/examples`
41
40
- Have a question, or find a bug? File an issue via [GitHub Issues](https://github.com/Azure/azure-sdk-for-rust/issues/new/choose).
42
41
- Check [previous questions](https://stackoverflow.com/questions/tagged/azure+rust) or ask new ones on StackOverflow using the `azure` and `rust` tags.
0 commit comments