Adds updates to the vehicles and introduction

.assets/openpilot-docs.css

@@ -51,7 +51,7 @@
   position: relative;
   margin: 0 auto;
   max-width:initial;
-  padding: 65px 25px 40px 25px;
+  padding: 65px 25px 110px 25px;
 }
 
 .navigation {
@@ -95,6 +95,7 @@
   margin-bottom: 16px;
   font-weight: 600;
   line-height: 1.25;
+  position:relative;
 }
 .markdown-section>*:first-child {
   margin-top: 0 !important;
@@ -241,4 +242,30 @@
   .navigation .label-page-title {
     display: none;
   }
+}
+
+.markdown-section img {
+  max-width:100%;
+}
+
+.anchorjs-link {
+  font-size: 17px;
+  display: block;
+  height: 100%;
+  width: 41px;
+  position:relative;
+}
+
+.anchorjs-link:before {
+  position: absolute;
+  top: 50%;
+  left: 32px;
+  transform: translate(-50%,-50%);
+
+  padding: 4px 6px;
+  background-color: #FFF!important;
+  border: 1px solid #EEE;
+}
+.anchorjs-link:after {
+  display:none;
 }

.vscode/settings.json

@@ -17,7 +17,7 @@
   "pasteImage.nameSuffix": "",
 
   // The destination to save image file.You can use variable ${currentFileDir} and ${projectRoot}. ${currentFileDir} will be replace by the path of directory that contain current editing file. ${projectRoot} will be replace by path of the project opened in vscode.
-  "pasteImage.path": "${projectRoot}/assets/images",
+  "pasteImage.path": "${projectRoot}/images",
   "pasteImage.basePath": "${projectRoot}",
 
   // The string prepend to the resolved image path before paste.

README.md

@@ -1,11 +1,36 @@
 # Introduction
 
-An open source documentation project for openpilot written for you by fellow members of the Comma community.
+Welcome to The Openpilot Documentation Project.
 
-## Help us create documentation
+The open source initiative to document [commaai/openpilot](https://github.com/commaai/openpilot), hardware it supports, and the vehicles it supports... all with the goal of aiming to be written for people of any skill level.
+
+Our documents and guides will try not to assume prior knowledge of any specific term or topic (within reason).
+
+# Why
+
+The current goals of the openpilot project have a lot to do with progress and prototyping to move the technology forward and very few people are interested in moving the on-boarding experience forward.  That's nobody's fault really, it's just the facts.
+
+So the goal is to bring a fresh take to the on-boarding experience to the table.
+
+What better way to do that than with GitHub and some Markdown.
+
+## Help create documentation
 
 Your contributions to the documentation are always welcome and will continue to make this a necessary resource for newcomers and veterans alike.
 
 [About Contributing](documentation/contributing.md)
 
-[![Build Status](https://travis-ci.org/openpilot-community/documentation.svg?branch=master)](https://travis-ci.org/openpilot-community/documentation)
+[![Build Status](https://travis-ci.org/openpilot-community/documentation.svg?branch=master)](https://travis-ci.org/openpilot-community/documentation)
+
+## Support the efforts
+
+All of this is paid for and maintained for free.
+
+### Buy stickers, show support
+
+![](images/2018-07-12-15-27-42.png)
+If you're interested, we are offering beautiful stickers for sale to help support the project, domain expenses, and hosting expenses.
+
+We will also vow to continue to donate our time to writing great articles and documents for you and the community.
+
+[Buy some stickers now!](https://redbubble.com/jfrux)

TABLE_OF_CONTENTS.md

@@ -6,28 +6,29 @@
 
 ### Vehicles
 
-* [Acura](./supported-vehicles/acura/README.md)
-  * [ILX](./supported-vehicles/acura/ilx.md)
-  * [RDX](./supported-vehicles/acura/rdx.md)
-* [Cadillac](./supported-vehicles/cadillac/README.md)
-  * [CT6](./supported-vehicles/cadillac/ct6.md)
-* [Chevrolet](./supported-vehicles/chevrolet/README.md)
-  * [Volt](./supported-vehicles/chevrolet/volt.md)
-* [Honda](./supported-vehicles/honda/README.md)
-  * [Accord](./supported-vehicles/honda/accord.md)
-  * [Civic](./supported-vehicles/honda/civic.md)
-  * [CR-V](./supported-vehicles/honda/cr-v.md)
-  * [Odyssey](./supported-vehicles/honda/odyssey.md)
-  * [Pilot](./supported-vehicles/honda/pilot.md)
-  * [Ridgeline](./supported-vehicles/honda/ridgeline.md)
-* [Lexus](./supported-vehicles/lexus/README.md)
-  * [RX](./supported-vehicles/lexus/rx.md)
-* [Tesla](./supported-vehicles/tesla/README.md)
-  * [Model S](./supported-vehicles/tesla/model-s.md)
-* [Toyota](./supported-vehicles/toyota/README.md)
-  * [Corolla](./supported-vehicles/toyota/corolla.md)
-  * [Prius](./supported-vehicles/toyota/prius.md)
-  * [RAV-4](./supported-vehicles/toyota/rav-4.md)
+* [Overview](./vehicles/README.md)
+* [Acura](./vehicles/acura/README.md)
+  * [ILX](./vehicles/acura/ilx.md)
+  * [RDX](./vehicles/acura/rdx.md)
+* [Cadillac](./vehicles/cadillac/README.md)
+  * [CT6](./vehicles/cadillac/ct6.md)
+* [Chevrolet](./vehicles/chevrolet/README.md)
+  * [Volt](./vehicles/chevrolet/volt.md)
+* [Honda](./vehicles/honda/README.md)
+  * [Accord](./vehicles/honda/accord.md)
+  * [Civic](./vehicles/honda/civic.md)
+  * [CR-V](./vehicles/honda/cr-v.md)
+  * [Odyssey](./vehicles/honda/odyssey.md)
+  * [Pilot](./vehicles/honda/pilot.md)
+  * [Ridgeline](./vehicles/honda/ridgeline.md)
+* [Lexus](./vehicles/lexus/README.md)
+  * [RX](./vehicles/lexus/rx.md)
+* [Tesla](./vehicles/tesla/README.md)
+  * [Model S](./vehicles/tesla/model-s.md)
+* [Toyota](./vehicles/toyota/README.md)
+  * [Corolla](./vehicles/toyota/corolla.md)
+  * [Prius](./vehicles/toyota/prius.md)
+  * [RAV-4](./vehicles/toyota/rav-4.md)
 
 ### Hardware
 

book.json

@@ -6,6 +6,7 @@
     "summary": "TABLE_OF_CONTENTS.md"
   },
   "plugins": [
+    "anchorjs",
     "sitemap",
     "edit-link",
     "alerts",
@@ -15,6 +16,14 @@
     "theme-openpilot"
   ],
   "pluginsConfig": {
+    "anchorjs": {
+      "selector": "h2,h3,h4,h5",
+      "icon": "#",
+      "placement": "left",
+      "class": "heading-anchor fa fa-link",
+      "truncate": 64,
+      "ariaLabel": "Anchor"
+    },
     "sitemap": {
       "hostname": "https://opc.ai/documentation"
     },

hardware/eon/README.md

@@ -2,8 +2,6 @@
 
 The EON is sold as a Dashcam by Comma.ai, Inc.  However, it is commonly not purchased for that purpose, rather; is used by motivated people to install third-party open source software on it known as [openpilot]().
 
-
-
 ## What is it made of?
 
 You'll notice that it looks like a cellphone with a funny case on it.
@@ -14,5 +12,4 @@ That's because that is precisely what it is in essence.  This is an [OmniPlus 3T
 
 Mounted to the back of it, and held on but 3D Printed ABS panels and pieces is a custom PCB board with a fan and large heat sync used to regulate the device from overheating because of how the CPU is clocked to do things it wasn't really ever designed to do.  Which although sounds bad, is actually an amazing thing for a smartphone and it's job is very important so that's why it exists.
 
-![Rendering of the EON from the back.](/assets/images/outward-facing%20%281%29.png)
-
+![Rendering of the EON from the back.](/assets/images/outward-facing%20%281%29.png)

hardware/pedal/guides/README.md

@@ -1 +1,5 @@
-# Pedal Guides
+# Pedal Guides
+
+{% for article in summary.parts[3].articles[2].articles %}
+- [{{ article.title }}](/{{ article.path }})
+{% endfor %}

vehicles/.base/vehicle-make.md

@@ -0,0 +1,26 @@
+# {{ page.title }}
+
+{% block preIntroMessage %}
+
+{% endblock %}
+
+{% block introMessage %}
+The goal is to always support as many vehicles as possible.
+
+Openpilot is compatible with *some* **{{ page.title }}** model(s) so feel free to browse the support pages for these models below for additional specifics.
+
+## Models
+
+This is the current list of {{page.title}} models being tested and/or actively supported by either community members or Comma.ai.  Varying levels of support / testing are being done on the listed models below so please follow the links below to keep up to date on individual model progress.
+
+{% for article in summary.parts[page.level.split('.')[0]-1].articles[page.level.split('.')[1]-1].articles %}
+ - [{{ article.title }}](/{{ article.path }})
+{% endfor %}
+{% endblock %}
+
+## How to add support for a vehicle
+
+If you own an unsupported vehicle but are interested in discussing porting it to openpilot, join us in the *NEW* [openpilot community chat support system](https://spectrum.chat/openpilot) and the always popular [Comma.ai Slack](https://slack.comma.ai/) if you prefer it.
+
+There will also be some great info on porting models in [Development Guides](../../development/guides/).
+

vehicles/.base/vehicle-model-header.md

@@ -0,0 +1,5 @@
+# {{ page.title }}
+
+The goal is to always support as many vehicles as possible.
+
+Openpilot is compatible with *some* **{{ page.title }}** trims so see below for more specifics.

vehicles/README.md

@@ -0,0 +1,58 @@
+# Vehicles
+
+The goal is to always support as many vehicles as possible.
+
+Openpilot is compatible with several vehicle makes already so feel free to browse the pages below for more info.
+
+## Makes
+
+This is the current list of makes being tested and/or actively supported by either community members or Comma.ai.
+
+Varying levels of support and/or testing are being done on these makes so please follow the links below to keep up to date on individual progress.
+
+A data source for our pages heavily comes from this maintained Google Sheet which we will continue to check and keep this up to date.
+
+You can find that sheet [here](https://docs.google.com/spreadsheets/d/1yDj2PqF-q9vcqpuMI9mnEmXTo-c056MQEaZUHmqGFnc/edit?usp=sharing).
+
+{% for article in summary.parts[page.level.split('.')[0]-1].articles %}
+{% if (article.title !== "Overview") %}
+ - [{{ article.title }}](/{{ article.path }})
+{% endif %}
+{% endfor %}
+
+### Notes on Ford Vehicles
+
+There is a port of openpilot for Ford, but the steering has a 10 second
+cutout limitation that makes it virtually unusable.
+
+Unless there is some real interest in hacking on Ford there won't be solid support
+for awhile.
+
+### Notes on Flexray Vehicles
+
+Unfortunately, vehicle makes that use [FlexRay](https://en.wikipedia.org/wiki/FlexRay) are
+unlikely to be supported any time soon.
+
+These makes include (but are not limited to):
+
+- Audi
+- BMW
+- Mercedes
+- Volvo
+
+## How to add support for a vehicle
+
+If you own an vehicle not currently listed
+but are interested in discussing porting it to openpilot,
+join us in the *NEW* [openpilot community chat support system](https://spectrum.chat/openpilot) and the
+always popular [Comma.ai Slack](https://slack.comma.ai/) if you prefer it.
+
+There *will* be some great info on porting vehicles in [Development Guides](../development/guides/).
+
+If your car has adaptive cruise control and lane keep assist, you are in luck.
+Using a [panda](https://comma.ai/shop/products/panda-obd-ii-dongle/) and
+[cabana](https://community.comma.ai/cabana/), you can understand how to
+make your car drive by wire.
+
+Comma.ai, Inc. wrote a [porting guide](https://medium.com/@comma_ai/openpilot-port-guide-for-toyota-models-e5467f4b5fe6) for
+Toyota that might help you after you have the basics figured out.

vehicles/acura/README.md

@@ -0,0 +1 @@
+{% extends "../.base/vehicle-make.md" %}

supported-vehicles/acura/ilx.md → vehicles/acura/ilx.md

@@ -1,4 +1,4 @@
-# ILX
+{% include "../.base/vehicle-model-header.md" %}
 
 ## Supported Models
 

supported-vehicles/acura/mdx.md → vehicles/acura/mdx.md

@@ -1,7 +1,8 @@
-# MDX
+{% include "../.base/vehicle-model-header.md" %}
+
 
 As of right now, we're not sure if anyone in the community has Openpilot working on the MDX but we have heard a few bits of chatter around the Slack channel related to MDX.
 
 The MDX has a specific steering type that causes it to not be as easy to work with.
 
-We will keep you posted as we learn more about this.
+We will keep you posted as we learn more about this.

supported-vehicles/acura/rdx.md → vehicles/acura/rdx.md

@@ -1,4 +1,5 @@
-# RDX
+{% include "../.base/vehicle-model-header.md" %}
+
 
 ## Supported Models
 
@@ -9,4 +10,4 @@
 
 ## Videos
 
-{{ 'https://www.youtube.com/watch?v=9IFvn-hIqZw' | video }}
+{{ 'https://www.youtube.com/watch?v=9IFvn-hIqZw' | video }}