Add docs
Open
Nobody has claimed this yet.
Area/Other
Priority/Highest
Severity/Blocker
Type/Task
- Dominant language
- Go
- Stars
- 71
- Forks
- 111
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 110
Description
Description
The API Platform repo is missing the docs directory. We need a docs directory and a quick-start to explain how to get going with the API platform.
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
No files or tests are named in the issue, so start by inspecting the repository structure and project entry points to understand how API Platform is run. Add the missing docs directory and a quick-start guide; it is done when a new user can follow the guide to get started.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100