Add search notebooks readme
#28
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
demjened
reviewed
Aug 7, 2023
notebooks/search/README.md
Outdated
Comment on lines
7
to
10
| 0. [Quick start 🔗](./00-quick-start.ipynb) | ||
| 1. [Keyword, querying, filtering 🔗](./01-keyword-querying-filtering.ipynb) | ||
| 2. [Hybrid search 🔗](./02-hybrid-search.ipynb) | ||
| 3. [Semantic search with ELSER 🔗](./03-ELSER.ipynb) |
There was a problem hiding this comment.
Aren't these supposed to be anchor links to jump to the corresponding section in the page?
Also, what are the 🔗 icons for?
Suggested change
| 0. [Quick start 🔗](./00-quick-start.ipynb) | |
| 1. [Keyword, querying, filtering 🔗](./01-keyword-querying-filtering.ipynb) | |
| 2. [Hybrid search 🔗](./02-hybrid-search.ipynb) | |
| 3. [Semantic search with ELSER 🔗](./03-ELSER.ipynb) | |
| 0. [Quick start 🔗](#0-quick-start-🔗) | |
| 1. [Keyword, querying, filtering 🔗](#1-keyword-querying-filtering-🔗) | |
| 2. [Hybrid search 🔗](#2-hybrid-search-🔗) | |
| 3. [Semantic search with ELSER 🔗](#3-semantic-search-with-elser-🔗) |
There was a problem hiding this comment.
Aren't these supposed to be anchor links to jump to the corresponding section in the page?
Also, what are the 🔗 icons for?
- Fixed anchor links, thanks!
- The icons were meant to make it super clear that the headings were links. I've changed the format, to remove this signposting. LMKWYT!
There was a problem hiding this comment.
I like it! The monospace formatting within the links makes them stand out, we should continue to use that to point to notebooks or examples.
|
@demjened @joemcelroy I went with bullet point summaries for this first category readme but I'm not sure if this is the best approach. LMKWYT! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.