Lepší README

Open
#567 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

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.

Description

technical

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

Dominant language
Python
Stars
46
Forks
115
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pyvec/python.cz

All issues in pyvec/python.cz

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.