Lepší README
Open
Nobody has claimed this yet.
technical
- Dominant language
- Python
- Stars
- 46
- Forks
- 115
- PR merge metrics
- No merged PRs in 30d
Description
Hlavně aby dokumentovalo, jak rozběhat projekt a co je účelem webovky (a co účelem té webovky - už - není). Viz https://github.com/pyvec/python.cz/pull/559
Hlavně zmínit, že skoro všechno je prostě zdokumentováno v dokumentaci MkDocs a hlavně mkdocs-material
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 and review the referenced pull request #559. Check the existing MkDocs and mkdocs-material documentation to summarize how to run the project, what the website is for, and which responsibilities it no longer has. Done means the README points readers to the relevant documentation and clearly covers setup and purpose.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100