Simplifying DocSearch documentation #624
Merged
Conversation
This file contains 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
|
Deploy preview for docusaurus-preview ready! Built with commit 3e0797c |
JoelMarcey
reviewed
Apr 30, 2018
There was a problem hiding this comment.
Hi @pixelastic - thank you for cleaning up our search docs. One question - is it worth keeping the extra search sections part, just without the example that shows facetFilters? Just say that you can configure even more broadly? Or you think removing all parts of that section is better?
|
Good call. From our experience most of the times the default config works just fine, but sometimes users need to add a few custom options in their config. For those cases I think it's better if the documentation clearly state where to add those options. I'll update the PR with those changes. |
I slightly rewrote the DocSearch documentation. The main three points are: - I explained a bit more how DocSearch works (trying to explain that it's an external service that requires the website to be online) - I removed mentions to the _search_ API key as in that case, it's always a _search_ (as opposed to _admin_) API key that is used - I removed the part about faceting on the version. I thought it was confusing as without a specific UI to display the faceting, this won't do much. To use it properly, one will need to dig more into layouts. I might submit a PR about that later, but as it was today I think it would just create confusing rather that adding value Hope that helps :)
This was referenced May 23, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
Hello, Tim from Algolia here. I'm one of the maintainers of DocSearch, and by reading the DocSearch/Docusaurus documentation I thought it could be simplified by slightly rewording the current version.
Here are the main points:
Hope that helps :)
Have you read the Contributing Guidelines on pull requests?
I did :)