g-rocket/docs

Documentation for the Spark API

Spark Documentation

Here you'll find the documentation for the Spark platform, including the Spark Cloud and the Spark Core.

To view this documentation, visit our website, where the documentation is hosted.

Hosting locally

To host this documentation locally, you'll need Node.js and npm. Once you have those, navigate to this repository's directory on your machine, and then:

npm install

to install the necessary dependencies (Express), and

npm start

to spin up Node to host this documentation. The default port is 3000, so you should find the documentation at

http://localhost:3000/

Organization

The majority of the content herein is stored in the docs directory as a set of Markdown files. Images are stored in the images directory. The root directory contains the HTML, CSS, and JavaScript that makes everything pretty and organized.

Attributions

Some of this documentation is derived from the Arduino documentation, as the Arduino/Wiring language and libraries are used extensively on the Spark Core.

This documentation is built using Flatdoc, an awesome tool for building beautiful documentation from simple Markdown files.

Contributions

This documentation is managed by Spark, but supported by the community. We welcome contributions such as:

• Edits to improve grammar or fix typos
• Edits to improve clarity
• Additional annotated examples for others to follow
• Additional content that would help provide a complete understanding of the Spark platform
• Translations to other languages

Making a contribution is as simple as forking this repository, making edits to your fork, and contributing those edits as a pull request. For more information on how to make a pull request, see Github's documentation.

License

These files have been made available online through a Creative Commons Attribution-ShareAlike 3.0 license.

You are welcome to distribute, remix, and use these files for commercial purposes. If you do so, please attribute the original design to Spark Labs, Inc. both on the website and on the physical packaging of the product or in the instruction manual. All derivative works must be published under the same or a similar license.