Skip to content

Latest commit

 

History

History
62 lines (38 loc) · 2.64 KB

README.md

File metadata and controls

62 lines (38 loc) · 2.64 KB

The Bonsai Platform Documentation

This project is the public home for the source code for the Bonsai Platform documentation. You can find our documentation at http://docs.bons.ai/.

Our hope is that open-sourcing our documentation on GitHub helps our docs stay a living, breathing, constantly evolving project that users feel empowered to contribute to. If any documentation is unclear/missing we invite you to submit an issue or a pull request. But if you’d just rather give us feedback directly, send us an email.

Frequently Asked Questions

What is this source code stuff? Where can I see the actual documentation?

You'll want to go to http://docs.bons.ai/ for the compiled version. This project shows the source code we used to generate it so that you can submit issues or pull requests to it.

How do I get my API documentation to look snazzy like yours?

Check out Slate.

Where do I go to get into the Bonsai Platform preview?

Apply here for access to our preview of the Bonsai Platform.

If You Want to Contribute

Prerequisites

You're going to need:

  • Linux or OS X — Windows may work, but is unsupported.
  • Ruby, version 2.2.5 or newer
  • Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Getting Set Up

  1. Fork this repository on Github.
  2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/bonsaiai.github.io.git
  3. cd bonsaiai.github.io
  4. Initialize and start Slate. You can either do this locally, or with Vagrant:
# either run this to run locally
bundle install
bundle exec middleman server

# OR run this to run with vagrant
vagrant up

# OR run this to run with Docker
docker-compose up

You can now see the docs at http://localhost:4567. Whoa! That was fast!

Now that Slate is all set up on your machine, you'll probably want to learn more about editing Slate markdown, or how to publish your docs.

For more information on using Docker, instructions are available in the Slate wiki.

Need Help? Found a bug?

Submit an issue to the Bonsai documentation repo if you need any help. And, of course, feel free to submit pull requests with bug fixes or changes if that's more your style.