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

WIP docs searchable #637

Closed

Conversation

alexiamcdonald
Copy link

Currently WIP

This should fix issue #35 and a little of #263.

This PR will add a search bar to the nav.
Screen Shot 2020-02-13 at 9 34 16 pm

Search will return results for queries
Screen Shot 2020-02-13 at 10 41 53 pm

To add:
returned queries print nicely with linked article and line where query is present. Currently, it's very ugly.

@alexiamcdonald
Copy link
Author

alexiamcdonald commented Feb 16, 2020

Would really love some feedback 😅

Screen Shot 2020-02-17 at 11 45 02 pm

@ticky
Copy link
Contributor

ticky commented Feb 20, 2020

@alexiamcdonald thanks for the PR! We’ve been all over the place with conferences and offsites the past couple of weeks but we will get to looking at this soon!

@harrietgrace
Copy link
Contributor

Hey @alexiamcdonald! Thanks for putting together this PR, search is sorely needed on the docs site. After internal discussion we’ve decided to close this PR, as we have a search implementation on the way behind a feature flag at the moment.

A little extra context: we’ve been wanting to add search forever! Sometime early last year we looked into adding Algolia and spiked out a trial, so we’ve actually had our search project 90% finished, but have had it shelved for a while 😅 thanks so much for providing us with inspiration to dust it off, do a big ol’ rebase, and finish things off 🙇🏻‍♀️ We didn’t want to close your PR without thorough discussion of the available approaches to search, so that’s why it’s taken us so long to get back to you.

Again, thanks for doing all this work, and I’m sorry to be closing your first docs PR rather than merging. I hope you’ll still consider future contributions! I absolutely love getting PRs to the docs 💖

Keep an eye out for search being added in the next couple of weeks 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants