New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme needs revamped #3

Open
snowkidind opened this Issue Oct 16, 2018 · 2 comments

Comments

4 participants
@snowkidind
Copy link
Contributor

snowkidind commented Oct 16, 2018

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
  • 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)

Ro5s added a commit to Ro5s/kb that referenced this issue Oct 30, 2018

Update README.md
Start revamping readme as discussed here: buildOMG#3

Includes initial references to License (MIT) / 'Contributing' & 'Code of Conduct' files (to be created).

@Ro5s Ro5s referenced this issue Oct 30, 2018

Closed

Update README.md #6

@Ro5s

This comment has been minimized.

Copy link
Contributor

Ro5s commented Oct 30, 2018

Started a bit on revamp (including suggestions): #6

@blainejohnson blainejohnson added the bounty label Nov 1, 2018

@nebali nebali added this to To do in Knowledge Base Nov 2, 2018

Ro5s added a commit that referenced this issue Nov 3, 2018

Update README.md
Start revamping readme as discussed here: #3 

Includes initial references to License (MIT) / 'Contributing' & 'Code of Conduct' files (to be created).
@Ro5s

This comment has been minimized.

Copy link
Contributor

Ro5s commented Nov 3, 2018

Started committing updates here: 370ca96

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment