mattpocock / mattpocock/evalite
Add an "Evalite By Example" section to "What Is Evalite?"
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- TypeScript
- Stars
- 1.7k
- Forks
- 102
- PR merge metrics
- No merged PRs in 30d
Description
I feel like Evalite can be explained in only a few code samples: evalite.each, custom scorers, the built-in scorer library, etc. We should make this a prominent part of the docs and put it in a section of "What is Evalite?"
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
Locate the documentation page titled "What Is Evalite?" and review its current structure. Add a prominent "Evalite By Example" section covering examples such as evalite.each, custom scorers, and the built-in scorer library; the work is done when these examples clearly explain Evalite in the page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100