Readme needs revamped
- Dominant language
- Python
- Stars
- 2
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
It's getting to be time to tweak the readme for this repository a little bit. It's the first thing one sees when stumbling across the repository and thusly should reflect a general gist of what it is and how it's used for the laymen. It should NOT go into details about OMG or it's product but about the basics of the knowledge base and the use cases associated with it, along with any main community messages regarding the project. It should answer the basic question of why am I here?
My take on sections are:
- links to the actual site, [https://kb.buildomg.org](https://kb.buildomg.org)
- an explanation of the purpose of the kb
- background on what caused this project to be started and how we got here.
- laymen manual on how to use the kb
- api access manual
- past roadmap of how it has developed.
- present goals
- future milestones for the project
- other project related thingies (chatbot etc)
- accredit those contributors who have put the effort into helping with the content
- open source licensing information (GPL)
Contributor guide
Research direction
Start by reading the repository's current README and the issue's proposed section list. Identify the existing explanation, usage guidance, API information, project history, goals, milestones, community links, contributor credits, and licensing details. Done means the README clearly explains why visitors should use the knowledge base and covers the requested topics for nontechnical readers.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 28/100