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

http://doc.rust-lang.org/book/ could use a search feature. #22786

Closed
foodhype opened this issue Feb 24, 2015 · 6 comments
Closed

http://doc.rust-lang.org/book/ could use a search feature. #22786

foodhype opened this issue Feb 24, 2015 · 6 comments
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@foodhype
Copy link

No description provided.

@steveklabnik steveklabnik added A-book T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Feb 24, 2015
@steveklabnik
Copy link
Member

tagging rustbook and rustdoc because this is a feature they'd need to add.

@asolove
Copy link

asolove commented Dec 28, 2015

I think adding a generic concordance feature or full text search to the underlying mdBook platform is not going to produce good results for an educational book like this. For a term like FnOnce, the chapters that use that term the most are likely not the best first reference for someone searching for that word.

Really good results will probably require some amount of manual effort. For FnOnce, for example, you'd want to have the very first reference be to the spot where it's defined and explained, then further references given to its usage in various examples or specific gotchas or comparisons to other function types.

Unless anyone objects, I'd like to try to manually create entries for a few terms based on the existing material in the new repo. I'll post a comparison to the results those terms get when the text is run through a concordance generator. Then we can compare both the effort and the payoff of the two approaches.

@nodakai
Copy link
Contributor

nodakai commented Apr 1, 2016

If it is difficult to add a search function, please consider publishing a concatenated version of the book as a single large HTML and let us use a search function of a web browser.

@0joshuaolson1
Copy link

Another option is pointing the user to a general search engine and restricting to the website.

@steveklabnik
Copy link
Member

Right now, our search works offline; it'd be nice to not lose that.

@steveklabnik
Copy link
Member

rustbook is no longer being developed, in favor of mdbook. If you'd like to see this feature, please report it to mdbook's tracker. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

5 participants