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

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

Open
moonheart08 opened this issue May 12, 2024 · 1 comment
Open
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@moonheart08
Copy link

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 Xtansia added documentation Improvements or additions to documentation and removed untriaged labels May 12, 2024
@Xtansia
Copy link
Collaborator

Xtansia commented May 12, 2024

@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

@Xtansia Xtansia added the good first issue Good for newcomers label May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants