meilisearch / meilisearch/meilisearch-js-plugins
Document how to include custom sortBy issue
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 531
- Forks
- 71
- Avg merge
- 10d 14h
- Merged PRs (30d)
- 2
Description
Description
I recently had some issues figuring out how to configure a custom sort parameter statically – without using the sortBy widget. As per this issue, the solution is to add the sort parameter directly to the index name (indexName: 'my_index:my_custom_param:asc'). This isn't documented anywhere as far as I can tell. It would be great to mention this in the README and provide examples for instantsearch-js as well as the InstantSearch libraries for React/Vue/etc.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the README and the linked issue #527 to confirm how a static sort parameter is encoded in the index name. Document the configuration with examples for instantsearch-js and the React, Vue, and other InstantSearch libraries; done means users can find and follow the examples without using the sortBy widget.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100