Skip to content

Commit

Permalink
fixes setup and some files for consistency
Browse files Browse the repository at this point in the history
- adds a package.json for easier setup
- renames network-api for consistency
- fixes some links to point to new gitbook paths
- removes Python from supported languages list
  • Loading branch information
HipsterBrown committed Jun 27, 2016
1 parent 82697de commit 484c929
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 24 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ _book
*.epub
*.mobi
*.pdf
npm-debug.log
3 changes: 1 addition & 2 deletions API/Languages.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Supported languages

* JavaScript/Node
* [Python (work in progress)](https://github.com/tessel/tessel-python)
* [JavaScript/Node](https://github.com/tessel/t2-firmware)
* [Rust (work in progress)](https://github.com/tessel/rust-tessel)
10 changes: 5 additions & 5 deletions API/Modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ The best place to find API documentation for a Tessel module is through the link

## Quick links

* [See all the modules and find their API documentation](//tessel.io/modules)
* [Learn how to use modules on the start page](//start.tessel.io/modules)
* [See all the modules and find their API documentation](https://tessel.io/modules)
* [Learn how to use modules on the start page](http://tessel.github.io/t2-start/)
* [Metadata about tenpin, USB, and community modules, including compatibility](https://github.com/tessel/hardware-modules)
* [Hardware docs for Tessel's first-party tenpin modules](https://github.com/tessel/hardware/blob/master/modules-overview.md)
* [How to make a module](//tessel.io/diy)
* [Communication protocols 101](https://tessel.io/docs/communicationProtocols)
* [Hardware docs for Tessel's first-party, tenpin modules](https://github.com/tessel/hardware/blob/master/modules-overview.md)
* [How to make a module](/Tutorials/Making_Your_Own_Module.html)
* [Communication protocols 101](/Tutorials/Communication_Protocols.html)

## Module design philosophy

Expand Down
File renamed without changes.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
Developer guide to Tessel 2 Docs Gitbook
============

# Tools
Install the following command line tools using `npm i {{toolname}} -g`
# Requirements
The docs are build using a command line tool called [GitBook](https://www.npmjs.com/package/gitbook), which requires:

* [gitbook](https://www.npmjs.com/package/gitbook)
* [gitbook-summary](https://github.com/imfly/gitbook-summary)
* [Node Version 4 or higher](https://nodejs.org/en/)
* [NPM Version 2 or higher](https://docs.npmjs.com/getting-started/installing-node)

# Running locally

Clone, `npm install`, and `gitbook serve`
* `git clone https://github.com/tessel/t2-docs.git`
* `cd t2-docs`
* `npm install`
* `npm start`

# Changing the contents

SUMMARY.md is autogenerated using the gitbook-summary tool. The command to regenerate is `book sm`. It receives instructions from book.json.
SUMMARY.md is autogenerated using the gitbook-summary tool, using instructions from `book.json`. The command to regenerate is `npm run build`, which is automatically run during the `npm start` command.
21 changes: 11 additions & 10 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# Tessel 2 Documentation

- API
* [CLI](/API/CLI.md)
* [Hardware API](/API/Hardware_API.md)
* [Languages](/API/Languages.md)
* [Modules](/API/Modules.md)
* [CLI](API/CLI.md)
* [Hardware API](API/Hardware_API.md)
* [Languages](API/Languages.md)
* [Modules](API/Modules.md)
* [Network API](API/Network_API.md)
- Debugging
* [LAN Discovery](/Debugging/LAN_Discovery.md)
* [Repos](/Debugging/Repos.md)
* [USB](/Debugging/USB.md)
* [Introduction](/Introduction.md)
* [LAN Discovery](debugging/LAN_Discovery.md)
* [Repos](debugging/Repos.md)
* [USB](debugging/USB.md)
- Tutorials
* [Communication Protocols](/Tutorials/Communication_Protocols.md)
* [Making Your Own Module](/Tutorials/Making_Your_Own_Module.md)
* [Communication Protocols](Tutorials/Communication_Protocols.md)
* [Making Your Own Module](Tutorials/Making_Your_Own_Module.md)
* [Introduction](Introduction.md)
2 changes: 1 addition & 1 deletion book.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"readme": "Introduction.md"
},
"catalog": "all",
"ignores": ["_book", ".git"],
"ignores": ["_book", "node_modules", "Introduction.md"],
"unchanged": [],
"plugins" : [ "anchors" ]
}
27 changes: 27 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"name": "t2-docs",
"version": "1.0.0",
"description": "The documentation site for the Tessel 2",
"dependencies": {
"gitbook-plugin-anchors": "^0.7.0"
},
"devDependencies": {
"gitbook-cli": "^2.3.0",
"gitbook-summary": "^1.1.2"
},
"scripts": {
"build": "book sm",
"postinstall": "gitbook install",
"start": "npm run build && gitbook serve"
},
"repository": {
"type": "git",
"url": "git+https://github.com/tessel/t2-docs.git"
},
"author": "",
"license": "SEE LICENSE IN LICENSE",
"bugs": {
"url": "https://github.com/tessel/t2-docs/issues"
},
"homepage": "https://github.com/tessel/t2-docs#readme"
}

0 comments on commit 484c929

Please sign in to comment.