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

Hosting the rustdocs #4791

Open
arpad-m opened this issue Jul 24, 2023 · 0 comments
Open

Hosting the rustdocs #4791

arpad-m opened this issue Jul 24, 2023 · 0 comments
Labels
a/documentation Area: related to documentation

Comments

@arpad-m
Copy link
Member

arpad-m commented Jul 24, 2023

Opening this for discussion/opinions. I'm wondering if we should host the rustdocs of the crates in this workspace somewhere (as well as their dependencies). Prior art would be the rust compiler docs.

The target audience of this would be contributors to the crates in the workspace, i.e. pageserver/proxy, etc, instead of Neon's users. IDEs provide a lot of features for code navigation, but rust documentation still fills a niche. With rust documentation of some function, you can provide a link in a discussion. If you on the other hand ran cargo doc locally, you would not be able to create links and often if you want to look something up, you are in a state where you . As the other alternative, docs.rs is great but it is always just one crate in the search index and the neon workspace is not published to crates.io, so it's not available there either.

Follow up of #4711.

@arpad-m arpad-m added the a/documentation Area: related to documentation label Jul 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a/documentation Area: related to documentation
Projects
None yet
Development

No branches or pull requests

1 participant