caddyserver / caddyserver/cache-handler
Document the default storage backend to the README
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 393
- Forks
- 28
- Avg merge
- 32m
- Merged PRs (30d)
- 1
Description
The link does not reveal which one the one storage is. The README would be improved by documenting this directly.
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
Start with README.md at lines 6-9, using the linked revision from the issue. Confirm which storage backend “one storage” refers to, then update that README section so the default is named directly; done means the documentation is unambiguous without following the link.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100