algolia / algolia/query-suggestions

Open-source usage

Open
#10 2 comments 3 reactions 0 assignees View on GitHub
Dominant language
Ruby
Stars
21
Forks
7
PR merge metrics
No merged PRs in 30d

Description

The current documentation (README.md and CONFIG.md) makes it pretty complex to use; we need to work on making the open-source usage easier.

Contributor guide

No contributing guide indexed for this repository

Research direction

Review README.md and CONFIG.md to understand the current open-source usage flow and identify what makes it difficult to follow. Done should mean that the documentation presents a noticeably simpler usage path, though the issue does not define specific acceptance criteria.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.