Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

Are you interested in upstreaming this to rustdoc? #12

Closed
jyn514 opened this issue Nov 5, 2021 · 6 comments
Closed

Are you interested in upstreaming this to rustdoc? #12

jyn514 opened this issue Nov 5, 2021 · 6 comments

Comments

@jyn514
Copy link

jyn514 commented Nov 5, 2021

I haven't looked in detail how roogle currently works, but I would love for it to be the default search rustdoc uses for the standard library and docs.rs :) would you be interested in working on that if I help out with the rusrdoc-specific parts?

@hkmatsumoto
Copy link
Member

I think that the upstreaming is feasible if not straightforward. We need to host another dedicated API server or upgrade the existing instance. Latterly, I'll go bankrupt though.

However, I and 2 rust-dev-tools members had privately (in hindsight, we should've done this publicly) discussed this 2 months ago, and we concluded that roogle and rustdoc will be served for different purposes; roogle for multi-crate function search, and rustdoc for single-crate general search. One thing to note is that if we were to again discuss this, perhaps we'll end up with another conclusion because 2 months ago roogle was naive in some aspects.

@hkmatsumoto
Copy link
Member

Maybe worth opening a thread on Zulip on this?

@Kixiron
Copy link

Kixiron commented Nov 6, 2021

Docs.rs has access to (more or less) all crates, it'd be interesting to try and make roogle work with something like rustdoc's json output to allow it to operate over all documentation.
This is a pretty far out idea, but still interesting to think about

@hkmatsumoto
Copy link
Member

it'd be interesting to try and make roogle work with something like rustdoc's json output to allow it to operate over all documentation.

Luckily enough, the index is the output of rustdoc's json backend now.

I think the most realistic approach here is that, add index and WASM of roogle to the resulting files of cargo doc.

@Kixiron
Copy link

Kixiron commented Nov 10, 2021

Yah, that definitely sounds good to me. In fact, it's much easier and could still provide cross-crate searches with some sort of "add crate" functionality (that is, you select crates to add to your search pool) and the site sends across the extra indices to be searched.
Best of both worlds imo, user flexibility and light on the host server

@hkmatsumoto
Copy link
Member

I need some elaboration on the "add crate" feature. Is this something like users requests a crate to be added to the search index?
IIUC that's definitely nice.

By the way, roogle now partially achieves the cross-crate search so please check that out (cf. b0ff61b).

@roogle-rs roogle-rs locked and limited conversation to collaborators Nov 18, 2021

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants