meilisearch / meilisearch/cheat-sheets
List the information we want to appear inside the cheat sheets
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
We need to list all the different information that we want to appear.
This could be (non-exhaustive list) :
- MeiliSearch / SDK version
- Links to get help (MeiliSearch's websites, documentation, github, Slack, ...)
- Installation guide
- Most used and useful methods / routes
- Usage examples
- ...
Contributor guide
No contributing guide indexed for this repository
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 with the requested information in this issue: versions, help links, installation, methods or routes, and usage examples. Define and confirm the complete information list for the cheat sheets; the issue provides no file or test entry point.
Written by the indexing model from the issue text.
Assessment
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100