Readme improvement
Open
Nobody has claimed this yet.
status:under discussion
type:docs
- Dominant language
- PHP
- Stars
- 34
- Forks
- 9
- Avg merge
- 1h 7m
- Merged PRs (30d)
- 1
Description
Let's add information about available keys in composer.json and configuration.php. I'd like to have this information before the Config Groups block. It will describe the top-level configuration options and give a definition about what "config group" is.
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 inspecting composer.json and configuration.php to identify the available top-level configuration options. Update the README before the Config Groups block with those options and a definition of “config group”; done means the requested information is documented in that location.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100