helpshift / helpshift/mongrove

Improve README

Open
#14 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
Clojure
Stars
10
Forks
8
PR merge metrics
No merged PRs in 30d

Description

Improve README doc.
Things that can be added:
1. Description and purpose
2. Getting started guide
3. Contributing guide
4. API doc link

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the repository's README and inspect the Clojure library's public usage and existing API references. Add the requested description, purpose, getting-started instructions, contributing guidance, and API documentation link; done means each section is present, accurate, and usable by a new contributor.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure, mongodb
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.