Hello, and welcome to the Documentation repo for Wilderness Labs! These docs are probably best viewed at the developer.wildernesslabs.co, but they should be readable here, as well. You'll also find all the source code to the samples here.
This repo is also a Ruby site powered by jekyll (which is how it's hosted by GitHub Pages). You can run and browse this site locally, which is especially useful if you're contributing documentation, or you just want an offline experience.
To browse locally on OSX (Steps 1 and 2):
1. Install Homebrew (if not already installed)
Open a terminal and navigate to the Documentation/docs folder and run:
$ brew install ruby
Once you have Ruby, you'll need Jekyll and Bundler to build and host the site locally:
$ sudo gem install jekyll bundler
With the Bundler installed to manage the Ruby gems, you can run a command to install all the prerequisite gems for the site:
(Change your terminal working folder to Documentation/docs)
$ bundle install
To browse locally on Windows (Steps 1 and 2):
1. Install Chocolatey (if not already installed)
Open a Powershell prompt and navigate to the Documentation/docs folder and run:
choco install ruby
Install MSYS2. Choose MSYS2 and MINGW development toolchain option
ridk install
Once you have Ruby and MSYS2, you'll need Jekyll and Bundler to build and host the site locally (tip: you may need to restart your shell):
$ gem install jekyll bundler
With the Bundler installed to manage the Ruby gems, you can run a command to install all the prerequisite gems for the site:
(Change your Powershell working folder to Documentation/docs)
$ bundle install
bundle exec jekyll serve
The site should be available locally at: http://127.0.0.1:4001/. You can verify the IP address and port from the jekyll output in terminal.
Changes should automatically be picked up and displayed on the site.
The three sites: Wildernesslabs.co, Docs, and Docfx share the same core front end code. Because of this, all front end modifications come from the WildernessLabs Web Repository.
To update the front end, setup a version of that repository and follow the instructions to make updates. Once you have that setup you can configure your watcher.
- Go into the
watch_config.jsonfile contained at root of the documentation repo. Update the path in that configuration to point to your WLabs_Web repo's dist directory - Run the
watch.rbtask using the command below. This will watch the dist directory for any changes that are made and move them to the 'docs' and 'docsfx repo'
ruby watch.rb
- In WLabs_Web repo run
gulp watchand update any front end files orgulp dist
Wilderness Labs welcomes and encourages constrictive contributions. We believe that documentation is best when a diverse community of folks with a variety of perspectives and experience share their wisdom and findings with others. Additionally, documentation contributions are a great way to capture learnings that you may even reference yourself.
For more information, please see the Contributing page.
Content copyright Wilderness Labs.
Electronics tutorial copyright Bryan Costanich.
All the documentation prose is released under a Creative Commons Attribution + Noncommercial + NoDerivatives (CC BY-NC-ND) license. Feel free to share verbatim in non-commercial usage and provide attribution. Commercial usage may be granted in certain use cases. If you need a more permissive license, please contact us at hello@wildernesslabs.co.
Human Readable Version of the License
All code samples and code snippets, whether they be full applications, or embedded snippets within the documentation are released under the Apache 2 license. Feel free to use and distribute the code as you see fit, under the very permissive terms of the license.