Automattic / Automattic/antiscroll

README doesn't explain how to use it

Open
#38 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
1.1k
Forks
156
PR merge metrics
No merged PRs in 30d

Description

README explains how it works but not actual usage.

How do you even set it up and invoke it?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the current README and identify the setup and invocation steps the project expects. Document those steps in the README, including a concrete usage example, so a new user can follow them without needing to infer how the project is used.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.