thefrontside / thefrontside/effection
Add API Guide
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 856
- Forks
- 39
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 8
Description
Apis are 🧠 🤯
How do we even begin to help people unpack the awesomeness of them. This is what we have to attempt, and so we'll have to add an API section to the guides.
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
The issue names no files, tests, or entry points; start by reviewing the existing guides and the project’s API surface to determine what the new API section should cover. Done means an API section has been added to the guides with an agreed scope and useful guidance for readers.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100