search

opensearch-project / opensearch-rs

OpenSearch Rust Client
Apache License 2.0
59 stars 34 forks source link

opensearch crate's documentation link should link to a rust doc site. #255

Open moonheart08 opened 4 months ago

moonheart08 commented 4 months ago

Issue

As of now, it links directly to the opensearch server documentation, instead of linking the library's documentation. This makes it more difficult to locate the already well developed rust-specific documentation directly from crates.io, which docs.rs rehosts here: https://docs.rs/opensearch/latest/opensearch/ (this is additionally where crates.io would point to by default if that field was not set)

Proposed solution

Just don't set this field to allow crates.io to set it automatically, or link to rustdoc output hosted on your preferred website.

Xtansia commented 4 months ago

@moonheart08 Thanks for reporting this! Would you be interested in making a PR to amend this? We can potentially move the opensearch.org link to be the homepage rather than documentation