Skip to content

Documentation for Rhomobile projects, in the form of a sinatra app.

Notifications You must be signed in to change notification settings

rhomobile/rhomobile-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

820eb9c · Dec 1, 2016
Mar 11, 2011
Dec 1, 2016
May 15, 2015
Jan 21, 2016
Mar 7, 2016
Aug 4, 2014
Dec 30, 2013
Jun 17, 2015
May 10, 2011
Jun 5, 2014
Jan 20, 2015
May 14, 2015
Mar 11, 2015
Jun 10, 2014
May 4, 2015
Mar 20, 2012
Dec 12, 2014
Feb 5, 2016
Sep 19, 2014
Feb 5, 2016
Feb 18, 2013
Aug 25, 2015
Jul 28, 2014
Jun 1, 2011
May 14, 2015
Oct 3, 2014
Mar 7, 2016

Repository files navigation

Rhomobile Documentation Project

This is a simple CMS and documentation for the Rhomobile platform: http://docs.rhomobile.com

Edge changes to this repository are tracked realtime on http://edgedocs.rhomobile.com

If you'd like to propose an edit to the Rhomobile docs, fork this repo, then send us a pull request.

This tool is based off the excellent heroku-docs project!

Setup

  • On Windows? Install the Development Kit. Then run:

      $ gem install rdiscount --platform=ruby -v=1.6.8
    
  • Run the following commands:

      # install prereqs and shotgun the docs server
      $ cd rhomobile-docs
      $ sudo gem install bundler (if you don't have it already)
      $ bundle install
      $ rake start #=> this will start the server and load the docs home page in your browser
    

Rebuilding & Publishing

This app loads content from sub-directories located in config.yml.

This will copy all content from the sub-directories into docs/. Then push to heroku:

$ git add docs/
$ git commit -m "adding new docs"
$ git push heroku master

The app loads content from the docs subdirectory. Pages are served with a 1 hour cache setting.

NOTE: Do NOT checkin changes to docs/(subdirectory) (i.e. docs/rhodes/). The content in docs/(subdirectory) are managed by the separate repositories. For example, content in docs/rhodes/ is maintained in the rhodes repo https://github.com/rhomobile/rhodes.

About

Originally written by Ryan Tomayko and Adam Wiggins. This application is maintained by Rhomobile Dev.

Code is released under the MIT License

All rights reserved on the content (text files in the docs subdirectory), although you're welcome to modify these for the purpose of suggesting edits.