Updates files for SEO

openpilot-community · Jul 23, 2018 · 05bb229 · 05bb229
1 parent e867e37
commit 05bb229
Show file tree

Hide file tree

Showing 98 changed files with 187 additions and 138 deletions.
diff --git a/.assets/openpilot-docs.css b/.assets/openpilot-docs.css
@@ -10,6 +10,28 @@
   color:#777;
 }
 
+.book-header div.h1 {
+  margin: 0;
+  font-size: 20px;
+  font-weight: 200;
+  text-align: center;
+  line-height: 50px;
+  opacity: 0;
+  -webkit-transition: opacity ease .4s;
+  -moz-transition: opacity ease .4s;
+  -o-transition: opacity ease .4s;
+  transition: opacity ease .4s;
+  padding-left: 200px;
+  padding-right: 200px;
+  -webkit-transition: opacity .2s ease;
+  -moz-transition: opacity .2s ease;
+  -o-transition: opacity .2s ease;
+  transition: opacity .2s ease;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  white-space: nowrap;
+}
+
 .gitbook-link {
   display:none!important;
 }

diff --git a/.includes/pre-page.md b/.includes/pre-page.md
diff --git a/.templates/vehicle-make.handlebars b/.templates/vehicle-make.handlebars
@@ -1,6 +1,7 @@
 ---
 id: {{slug}}
 title: {{Name}}
+description: Information about running Comma.ai Openpilot on {{Name}} vehicles including the {{#each Models}}{{Name}} and {{/each}} others.
 ---
 {{!-- 
 ***************************************
@@ -11,9 +12,8 @@ PLEASE USE AIRTABLE.COM DATABASE TO UPDATE
 --}}
 # {{Name}}
 
-The goal is to always support as many vehicles as possible.
-
 Openpilot is compatible with *some* **{{Name}}** model(s) so feel free to browse the support pages for these models below for additional specifics.
+The goal is to always support as many vehicles as possible.
 
 To chat about {{Name}}'s with the community, checkout the #{{id}} channel in the [Comma Slack](https://slack.comma.ai).
 

diff --git a/.templates/vehicle-model.handlebars b/.templates/vehicle-model.handlebars
@@ -1,11 +1,12 @@
 ---
 id: {{slug}}
 title: {{Name}}
+description: Information about running Comma.ai Openpilot on {{make.Name}} {{Name}} vehicles.
 ---
 # {{make.Name}} {{Name}}
 
-The goal is to support as many vehicles as possible.
 Openpilot is compatible with *some* **{{Name}}** model(s) so feel free to browse the support pages for these models below for additional specifics.
+The goal is to support as many vehicles as possible.
 
 To chat about {{Name}}'s with the community, checkout {{#if SlackChannel}}the # channel in{{/if}} the [Comma Slack](https://slack.comma.ai).
 

diff --git a/.templates/vehicle.handlebars b/.templates/vehicle.handlebars
@@ -1,6 +1,7 @@
 ---
 id: {{slug}}
 title: {{ FullName }}{{#if RequiredFactoryPkg}} w/ {{RequiredFactoryPkg}}{{else}}{{#if RequiresFactoryUpgrades}} w/ {{RequiresFactoryUpgrades}}{{/if}}{{/if}}
+description: Information about running Comma.ai Openpilot on the {{ FullName }}{{#if RequiredFactoryPkg}} w/ {{RequiredFactoryPkg}}{{else}}{{#if RequiresFactoryUpgrades}} w/ {{RequiresFactoryUpgrades}}{{/if}}{{/if}}
 ---
 {{!-- 
 ***************************************

diff --git a/.templates/vehicles.handlebars b/.templates/vehicles.handlebars
@@ -1,6 +1,7 @@
 ---
 id: vehicles
 title: Vehicles
+description: Information about running Comma.ai Openpilot on many existing auto makers including but not limited to {{#each makes}}{{Name}} and {{/each}} and many more.
 ---
 {{!-- 
 ***************************************

diff --git a/deploy.sh b/deploy.sh
diff --git a/deploy_key.enc b/deploy_key.enc
diff --git a/hardware/README.md b/hardware/README.md
@@ -1,3 +1,8 @@
+---
+id: hardware
+title: Hardware
+description: Information about the many different pieces of hardware you can use to assist openpilot in driving your vehicle.
+---
 # Hardware
 
 ### [EON](eon)

diff --git a/hardware/eon/README.md b/hardware/eon/README.md
@@ -1,3 +1,8 @@
+---
+id: eon
+title: EON
+description: Information about Comma.ai EON, including where to buy, how to mount it, and how to install openpilot.
+---
 # EON
 
 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]().

diff --git a/hardware/eon/get-an-eon.md b/hardware/eon/get-an-eon.md
@@ -1,3 +1,8 @@
+---
+id: get-an-eon
+title: Get an EON
+description: Information about how to buy a Comma.ai EON
+---
 # Get an EON
 
 ## Purchasing an EON
@@ -13,5 +18,6 @@ Well, it is entirely possible to build it yourself but it may end up costing you
 I recommend checking out the [**Comma Wiki**](https://community.comma.ai/wiki/index.php/Neo) and the [**Comma Neo Repository**](https://github.com/commaai/neo) for information on the pieces needed to make it work.
 
 ### Examples of some builds
+
 ![](/images/get-an-eon_2018-07-09-09-32-07.png)
 ![](/images/get-an-eon_2018-07-09-09-33-00.png)
diff --git a/hardware/giraffe/README.md b/hardware/giraffe/README.md
@@ -1,3 +1,8 @@
+---
+id: giraffe
+title: Giraffe
+description: The Giraffe is a piece of hardware that allows Panda to get access to the vehicle's control buses that are generally not exposed via the standard diagnostics port.  Usually the LKAS and ACC sensors and commands live on these buses.
+---
 # Giraffe
 
 The Giraffe is a piece of hardware that allows Panda to get access to the vehicle's control buses that are generally not exposed via the standard diagnostics port.  Usually the LKAS and ACC sensors and commands live on these buses.
diff --git a/hardware/giraffe/get-a-giraffe.md b/hardware/giraffe/get-a-giraffe.md
@@ -1,3 +1,9 @@
+---
+id: get-a-giraffe
+title: Get a Giraffe
+description: Information about how to buy a Giraffe for your vehicle.
+---
+
 # Get a Giraffe
 
 ## Find the one you need

diff --git a/hardware/giraffe/types-of-giraffes.md b/hardware/giraffe/types-of-giraffes.md
@@ -1,3 +1,8 @@
+---
+id: types-of-giraffes
+title: Types of Giraffe
+description: Information about the different types of Giraffe's available for different vehicles.
+---
 # Types of Giraffes
 
 There are 3 official types of Giraffe's you can buy from Comma.ai but many community members have built custom ones for specific vehicle requirements.  Visit the [Vehicles](/vehicles) section to find the right Giraffe for your vehicle make / model.

diff --git a/hardware/panda/README.md b/hardware/panda/README.md
@@ -1,3 +1,8 @@
+---
+id: panda
+title: Panda
+description: The Panda is a universal interface for your car.
+---
 # Panda
 
 The Panda is a universal interface for your car.

diff --git a/hardware/panda/get-a-panda.md b/hardware/panda/get-a-panda.md
@@ -1,3 +1,8 @@
+---
+id: get-a-panda
+title: Where to get a Panda
+description: Information about where to buy the different types of Panda's.
+---
 # Get a Panda
 
 ## Grey Panda

diff --git a/hardware/pedal/README.md b/hardware/pedal/README.md
@@ -1,3 +1,8 @@
+---
+id: pedal
+title: Pedal
+description: The Pedal is not a physical gas pedal or brake pedal, it's an interceptor device used to send small  signals to your car to apply the gas during times when your stock vehicle otherwise would not.
+---
 # Pedal
 
 The Pedal is not a physical gas pedal or brake pedal, it's an interceptor device used to send small  signals to your car to apply the gas during times when your stock vehicle otherwise would not.

diff --git a/vehicles/README.md b/vehicles/README.md
@@ -1,6 +1,7 @@
 ---
 id: vehicles
 title: Vehicles
+description: Information about running Comma.ai Openpilot on many existing auto makers including but not limited to Acura and Cadillac and Chevrolet and Honda and Hyundai and Kia and Lexus and Tesla and Toyota and  and many more.
 ---
 # Vehicles
 

diff --git a/vehicles/acura/README.md b/vehicles/acura/README.md
@@ -1,12 +1,12 @@
 ---
 id: acura
 title: Acura
+description: Information about running Comma.ai Openpilot on Acura vehicles including the ILX and RDX and  others.
 ---
 # Acura
 
-The goal is to always support as many vehicles as possible.
-
 Openpilot is compatible with *some* **Acura** model(s) so feel free to browse the support pages for these models below for additional specifics.
+The goal is to always support as many vehicles as possible.
 
 To chat about Acura's with the community, checkout the # channel in the [Comma Slack](https://slack.comma.ai).
 

diff --git a/vehicles/acura/ilx.md b/vehicles/acura/ilx.md
@@ -1,11 +1,12 @@
 ---
 id: ilx
 title: ILX
+description: Information about running Comma.ai Openpilot on Acura ILX vehicles.
 ---
 # Acura ILX
 
-The goal is to support as many vehicles as possible.
 Openpilot is compatible with *some* **ILX** model(s) so feel free to browse the support pages for these models below for additional specifics.
+The goal is to support as many vehicles as possible.
 
 To chat about ILX's with the community, checkout  the [Comma Slack](https://slack.comma.ai).
 

diff --git a/vehicles/acura/ilx/2016-acura-ilx.md b/vehicles/acura/ilx/2016-acura-ilx.md
@@ -1,6 +1,7 @@
 ---
 id: 2016-acura-ilx
 title: 2016 Acura ILX w/ AcuraWatch Plus
+description: Information about running Comma.ai Openpilot on the 2016 Acura ILX w/ AcuraWatch Plus
 ---
 # 2016 Acura ILX w/ AcuraWatch Plus
 

diff --git a/vehicles/acura/ilx/2017-acura-ilx.md b/vehicles/acura/ilx/2017-acura-ilx.md
@@ -1,6 +1,7 @@
 ---
 id: 2017-acura-ilx
 title: 2017 Acura ILX w/ AcuraWatch Plus
+description: Information about running Comma.ai Openpilot on the 2017 Acura ILX w/ AcuraWatch Plus
 ---
 # 2017 Acura ILX w/ AcuraWatch Plus
 

diff --git a/vehicles/acura/rdx.md b/vehicles/acura/rdx.md
@@ -1,11 +1,12 @@
 ---
 id: rdx
 title: RDX
+description: Information about running Comma.ai Openpilot on Acura RDX vehicles.
 ---
 # Acura RDX
 
-The goal is to support as many vehicles as possible.
 Openpilot is compatible with *some* **RDX** model(s) so feel free to browse the support pages for these models below for additional specifics.
+The goal is to support as many vehicles as possible.
 
 To chat about RDX's with the community, checkout  the [Comma Slack](https://slack.comma.ai).
 

diff --git a/vehicles/acura/rdx/2018-acura-rdx.md b/vehicles/acura/rdx/2018-acura-rdx.md
@@ -1,6 +1,7 @@
 ---
 id: 2018-acura-rdx
 title: 2018 Acura RDX w/ AcuraWatch Plus
+description: Information about running Comma.ai Openpilot on the 2018 Acura RDX w/ AcuraWatch Plus
 ---
 # 2018 Acura RDX w/ AcuraWatch Plus
 

diff --git a/vehicles/cadillac/README.md b/vehicles/cadillac/README.md
@@ -1,12 +1,12 @@
 ---
 id: cadillac
 title: Cadillac
+description: Information about running Comma.ai Openpilot on Cadillac vehicles including the CT6 and  others.
 ---
 # Cadillac
 
-The goal is to always support as many vehicles as possible.
-
 Openpilot is compatible with *some* **Cadillac** model(s) so feel free to browse the support pages for these models below for additional specifics.
+The goal is to always support as many vehicles as possible.
 
 To chat about Cadillac's with the community, checkout the # channel in the [Comma Slack](https://slack.comma.ai).
 

diff --git a/vehicles/cadillac/ct6.md b/vehicles/cadillac/ct6.md
@@ -1,11 +1,12 @@
 ---
 id: ct6
 title: CT6
+description: Information about running Comma.ai Openpilot on Cadillac CT6 vehicles.
 ---
 # Cadillac CT6
 
-The goal is to support as many vehicles as possible.
 Openpilot is compatible with *some* **CT6** model(s) so feel free to browse the support pages for these models below for additional specifics.
+The goal is to support as many vehicles as possible.
 
 To chat about CT6's with the community, checkout  the [Comma Slack](https://slack.comma.ai).
 

diff --git a/vehicles/cadillac/ct6/2018-cadillac-ct6.md b/vehicles/cadillac/ct6/2018-cadillac-ct6.md
@@ -1,6 +1,7 @@
 ---
 id: 2018-cadillac-ct6
 title: 2018 Cadillac CT6
+description: Information about running Comma.ai Openpilot on the 2018 Cadillac CT6
 ---
 # 2018 Cadillac CT6
 

diff --git a/vehicles/chevrolet/README.md b/vehicles/chevrolet/README.md
@@ -1,12 +1,12 @@
 ---
 id: chevrolet
 title: Chevrolet
+description: Information about running Comma.ai Openpilot on Chevrolet vehicles including the Volt and  others.
 ---
 # Chevrolet
 
-The goal is to always support as many vehicles as possible.
-
 Openpilot is compatible with *some* **Chevrolet** model(s) so feel free to browse the support pages for these models below for additional specifics.
+The goal is to always support as many vehicles as possible.
 
 To chat about Chevrolet's with the community, checkout the # channel in the [Comma Slack](https://slack.comma.ai).