scverse / scverse/cookiecutter-scverse
improve docs structure
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 89
- Forks
- 17
- Avg merge
- 21h 16m
- Merged PRs (30d)
- 7
Description
I think should be a guide on “how to get this running ASAP”, that basically shows a screenshot of a correctly configured “Installed Apps” section in a project’s GitHub settings
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
Review the repository's existing documentation structure and identify the appropriate location for a quick-start guide. Add guidance for getting the project running ASAP, including a screenshot of a correctly configured Installed Apps section in GitHub project settings; done means the guide and screenshot are present and understandable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100