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

Add searchbar to docs #858

Merged
merged 9 commits into from
Jul 26, 2022
Merged

Add searchbar to docs #858

merged 9 commits into from
Jul 26, 2022

Conversation

Etesam913
Copy link
Contributor

@Etesam913 Etesam913 commented Jul 22, 2022

Resolves #709

Login to algolia here:

https://www.algolia.com/users/sign_in

You can see search plugin here:

https://www.algolia.com/dashboard

To trigger a manual crawl(website gets automatically crawled once every week) of the website login here:

https://crawler.algolia.com/

manual_crawl

The button to click for a manual crawl

Double Search Result Issue (RESOLVED)

  • Fixed issue of double search results by adding the below line in the crawler config(click editor after visiting crawler link above)
    exclusionPatterns: ["https://mephisto.ai//*/**"],
  • For some reason the crawler was picking up links with a double //, so I am just excluding them now
    • These were the search result links that were not working, so all the search result links should work now.

Video

search.mov

Issue to be resolved later:

  • Clicking the "see all results" text takes you to a page that allows you to "see all results."

Video of the bug (I unhid the "see all results" text for this video)

video-with-error.mov

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jul 22, 2022
Copy link
Contributor

@pringshia pringshia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this! It immediately makes the docs way more useful and accessible.

Have one small comment re: a config value, but otherwise LGTM.

Copy link
Contributor

@pringshia pringshia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually... some comments need to be addressed first

@codecov-commenter
Copy link

codecov-commenter commented Jul 25, 2022

Codecov Report

Merging #858 (4fca82a) into main (43d40b2) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #858   +/-   ##
=======================================
  Coverage   64.44%   64.44%           
=======================================
  Files         107      107           
  Lines        9283     9283           
=======================================
  Hits         5982     5982           
  Misses       3301     3301           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 43d40b2...4fca82a. Read the comment docs.

🎨 Hid the see more text as the see more page is currently broken

🔀 Merged with main
@Etesam913 Etesam913 added the documentation Improvements or additions to documentation label Jul 25, 2022
@Etesam913 Etesam913 changed the title [WIP] Add searchbar to docs Add searchbar to docs Jul 25, 2022
searchParameters: {},

// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: "search",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we also bring back this config and set it to false?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I set searchPagePath to false

@Etesam913 Etesam913 requested a review from pringshia July 26, 2022 14:13
Copy link
Contributor

@pringshia pringshia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ty!

@Etesam913 Etesam913 merged commit d000d70 into main Jul 26, 2022
@Etesam913 Etesam913 deleted the add-search-to-docs branch July 26, 2022 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable search on docs
4 participants