Skip to content

README.md

Latest commit

 

History

History
36 lines (29 loc) · 2.3 KB

README.md

File metadata and controls

36 lines (29 loc) · 2.3 KB

MooGPT Documentation

This repo is the home of the unified MooGPT docs hosted at website. This repo is NOT the place to contribute to or report issues on any of the players or the SimSimi chatbot.

Contributing to the docs directly on GitHub (easy)

Because the MooGPT docs are created directly from the markdown in this repo, you can use the GitHub web editor to edit and propose changes to the docs directly from your browser without any knowledge of git. To do that, find the markdown file with the docs you want to edit and follow GitHub's instructions to edit and propose changes to a markdown file. Once approved, the docs will be updated immediately.

Contributing to the docs by forking this repo (still pretty easy)

MooGPT website runs on docsify. Docsify was chosen because it takes hosted markdown and generates the page dynamically. That means that simply updating the markdown files here is all that is needed to update MooGPT docs.

  1. Fork and clone this repo.
  2. Install docsify: sudo npm install -g docsify-cli.
  3. Startup the local docsify server with docsify serve . from the root of this repo.
  4. Edit the markdown and verify your changes on the localhost url outputted from the docsify serve command.
  5. Put up a pull request to this repo and tag @gpeal
  6. Enjoy the updated docs!

Looking for the libraries?

Official Libraries

Unofficial Libraries