Skip to content

WildernessLabs/Documentation

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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.

Running Locally

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)

2. Install prerequisites: Ruby, Jekyll, Bundler, and various gems

  1. Open a terminal and navigate to the Documentation/docs folder and run:

    $ brew install ruby
    
  2. Once you have Ruby, you'll need Jekyll and Bundler to build and host the site locally:

    $ sudo gem install jekyll bundler
    
  3. 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)

2. Install prerequisites: Ruby, Jekyll, Bundler, and various gems

  1. Open a PowerShell prompt and navigate to the Documentation/docs folder and run:

    choco install ruby
    
  2. Install MSYS2 using Ruby Installer 2 (ridk). Then, choose MSYS2 and MINGW development toolchain option (tip: you may need to restart your shell):

    ridk install
    

    If you encounter several key verification errors during the toolchain setup, ridk may have installed an older version of MSYS2 with bad key validation. You can upgrade the version installed by ridk using Chocolatey.

    choco upgrade msys2
    

After OS installs

Once you have Ruby and MSYS2, you'll need Jekyll and Bundler to build and host the site locally:

$ 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; and you may need to restart your shell if you just installed the prerequisites.)

$ bundle install

3. Launch local server

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.

Customizing the front end

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.

  1. Go into the watch_config.json file contained at root of the documentation repo. Update the path in that configuration to point to your WLabs_Web repo's dist directory

  2. Run the watch.rb task 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
    
  3. In WLabs_Web repo run gulp watch and update any front end files or gulp dist

Contributing

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.

License

Copyright

Content copyright Wilderness Labs.

Electronics tutorial copyright Bryan Costanich.

Documentation Prose

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.

Creative Commons BY-NC-ND Logo

Human Readable Version of the License

Code Samples and Code Snippets

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.