algolia / algolia/chunk-text

Better document chunk size limit

Open Beginner friendly
#3 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
44
Forks
6
PR merge metrics
No merged PRs in 30d

Description

With current readme, users might think we always truncate words.
The purpose of this lib is the exact opposite.

The word truncating is an edge case where there would be no space at all in the limit of the chunk size.

Let's make that clearer in the readme!

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the README and review the section describing chunk size limits and word truncation. Clarify that words are only truncated as an edge case when no space fits within the limit, then verify that the documentation accurately explains the library's purpose.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.