greg/mentat
1
0
Fork 0
Code Issues 294 Pull requests Packages Projects Releases 9 Wiki Activity
mentat/docs
History
Greg Burd 4f81c4e15b Attempting to cleanup with clippy, rustfmt, etc. 
Integrate https://github.com/mozilla/mentat/pull/806
2020-01-31 10:55:45 -05:00
..
_includes Mentat documentation website using Jekyll (#754) 2018-06-25 11:20:36 +01:00
_layouts Remove duplicated header (#764) 2018-06-25 12:11:58 +01:00
_posts Mentat documentation website using Jekyll (#754) 2018-06-25 11:20:36 +01:00
apis Fix broken documentation links. (#775) (#767) r=nalexander 2018-06-29 10:28:44 -07:00
.gitignore Mentat documentation website using Jekyll (#754) 2018-06-25 11:20:36 +01:00
404.html Mentat documentation website using Jekyll (#754) 2018-06-25 11:20:36 +01:00
_config.yml Setting baseurl (#763) 2018-06-25 12:01:16 +01:00
about.md Mentat documentation website using Jekyll (#754) 2018-06-25 11:20:36 +01:00
CONTRIBUTING.md Mentat documentation website using Jekyll (#754) 2018-06-25 11:20:36 +01:00
Gemfile Attempting to get minima theme building on github (#762) 2018-06-25 11:56:59 +01:00
Gemfile.lock Attempting to get minima theme building on github (#762) 2018-06-25 11:56:59 +01:00
index.md Fix broken documentation links. (#775) (#767) r=nalexander 2018-06-29 10:28:44 -07:00
README.md Fix broken documentation links. (#775) (#767) r=nalexander 2018-06-29 10:28:44 -07:00
tutorial.md Attempting to cleanup with clippy, rustfmt, etc. 2020-01-31 10:55:45 -05:00

README.md

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/