KwickerHub / KwickerHub/backend
Documentation
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 2
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
We need proper documentation of this repository.
Dev Documentation
All the files and the different thing the files do so that it will be easy for other developers to contribute.
User Documentation
The different endpoints and the different kinds of data feedback the endpoints provide. Some provide JSON structures, strings or raw html content.
Contributor guide
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
Start by inventorying the repository and identifying the files and endpoints that need coverage. Separate developer documentation for file responsibilities from user documentation for endpoint responses, including JSON structures, strings, and raw HTML. Done means contributors can understand the files and users can find each endpoint's response format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- api, backend, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100