greg/mentat
1
0
Fork 0
Code Issues 294 Pull requests Projects Releases 9 Packages Wiki Activity
mentat/docs/README.md
Emily Toop da599c3a78 Fix broken documentation links. (#775) (#767) r=nalexander 
* Fix broken API doc links

Create symlink for latest to point to v0.7.
Group APIs by top version number rather than individual

* Update swift and android version numbers to match Mentats

* Update documentation

* Update top level .gitignore to ignore docs site & metatdata

* Add README to help with building documentation site

* Address review comments @ncalexan
2018-06-29 10:28:44 -07:00

735 B
Raw Blame History

Project Mentat Documentation Site

This site is a place to provide the users of Mentat with all the documentation, examples and tutorials required in order to use Mentat inside a project.

This site will contain the following:

  • API Documentation for Mentat and it's SDKs.
  • Tutorials for cross compilation of Mentat for other platforms. (Coming)
  • Examples of how to design data for storage in Mentat.
  • Examples of how to use Mentat and it's SDKs. (Coming)
  • Quick Start Guides for installing and using Mentat. (Coming)

Build and run locally

1. Install [Jekyll](https://jekyllrb.com/docs/installation/)
2. `cd docs`
3. `bundle exec jekyll serve --incremental`
4. open local docs site at http://127.0.0.1:4000/