Getting Started...
Open
Nobody has claimed this yet.
- Dominant language
- Luau
- Stars
- 569
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
Description
Is there any intention or possibility to add a getting started section to the API reference or elsewhere? I'm especially interested in trying this out, but I can't seem to find information in how to get started in including/importing the library into a project.
Contributor guide
No contributing guide indexed for this repository
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
Review the API reference and existing project documentation to identify where users need guidance on getting started and including the library. Add a concise getting-started section covering the initial setup and import path, with enough information for a new user to begin using the library.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100