Skip to content

Commit

Permalink
Updates to documentation for new website theme implementation (#912)
Browse files Browse the repository at this point in the history
* Updated image include to use the full path to the image

* Updated README.md's to hide table of contents with toc and updated table styling
  • Loading branch information
Kyle authored Nov 27, 2020
1 parent 49596d1 commit f35cfd9
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 8 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Documentation
permalink: /documentation/
redirect_from:
- /documentation/README.md/
toc: false
---
Welcome to the official documentation for 96Boards, this documentation is written by the 96Boards team at Linaro with community contribution and links to third party material.

Expand All @@ -13,15 +14,16 @@ Select your platform for a list of supported products (left), or jump to 96Board
- [96Boards Guides](guides/)
- [Contribute to this repository](CONTRIBUTE.md)

<div style="overflow-x:scroll;" markdown="1">
<div class="table-responsive" markdown="1">

| Platform | Description | Boards |
|:---------------------------------------:|:-------------------------------------------:|:-------------------------------------------|
| [**IoT Edition**](iot/) <br>[<img src="/assets/images/content/96IoT.svg" width="240" height="100" />](iot/) | Expand on all 96Boards with new interfaces for IoT, industrial<br>control, and other embedded applications. | [View Boards](iot/) |
| [**Consumer Edition**](consumer/)<br> [<img src="/assets/images/content/96Consumer.svg" width="240" height="100" />](consumer/) <br> | These small, low-cost, and low-power consumer 96Boards<br>are great for developers, makers, and hobbyists! | [View Boards](consumer/)<br>[Guides](consumer/guides/)<br>[Compare](consumer/guides/compare_96boards_ce.md) |
| [**Enterprise Edition**](enterprise/) <br>[<img src="/assets/images/content/96Enterprise.svg" width="240" height="100" />](enterprise/)| These powerful, reliable, ARM based 96Boards boards are<br>ideal targets for networking and server segments| [View Boards](enterprise/)<br> |
| [**Mezzanine**](mezzanine/) <br>[<img src="/assets/images/content/96Partner.svg" width="240" height="100" />](mezzanine/) | Expand on all 96Boards with new interfaces for IoT,<br>industrial control, and other embedded applications. | [View Boards](mezzanine/) |

{:.table}
#
</div>

***
Expand Down
1 change: 1 addition & 0 deletions Specifications/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ redirect_from:
- /tv-specification
- /camera-spec
- /som-specification
toc: false
---
- Consumer Edition Specification ([View](/documentation/Specifications/96Boards-CE-Specification.pdf) / [Download](https://linaro.co/ce-specification))
- Low-cost Hardware Platform Specification
Expand Down
4 changes: 3 additions & 1 deletion consumer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ redirect_from:
- /documentation/ConsumerEdition/README.md/
- /documentation/ConsumerEdition
- /documentation/consumer/README.md/
toc: false
---
Welcome to the official documentation for Consumer Edition 96Boards, these documents are written by the [96Boards](https://www.96boards.org) team at [Linaro](http://www.linaro.org) with community contributions and links to third-party content.

Expand All @@ -15,7 +16,7 @@ Select your Consumer Edition 96Boards device to access all product specific reso
- [Compare 96Boards](guides/compare_96boards_ce.md)
- [96Boards CE Extras](guides/)

<div style="overflow-x:scroll;" markdown="1">
<div class="table-responsive" markdown="1">

| 96Boards | About | Options |
|:------------------------------------------------:|:------------------------------------------------------:|:--------------------------:|
Expand All @@ -36,5 +37,6 @@ Select your Consumer Edition 96Boards device to access all product specific reso
<img src="https://i.imgur.com/ndacN8g.png" data-canonical-src="https://i.imgur.com/ndacN8g.png" width="200" height="130" /><br> **MediaTek X20** | Board based on MediaTek X20 Applications Processor | [Documentation](mediatekx20/)<br> |
| <img src="https://github.com/96boards/documentation/blob/master/consumer/mediatekx20pro/additional-docs/images/images-board/sd/mediatekx20pro-front-sd.jpg?raw=true" data-canonical-src="https://github.com/96boards/documentation/blob/master/consumer/mediatekx20pro/additional-docs/images/images-board/sd/mediatekx20pro-front-sd.jpg?raw=true" width="200" height="130" /><br> **MediaTek X20 Pro** | Board based on MediaTek X20 Applications Processor | [Documentation](mediatekx20pro/)<br> |
| <img src="https://github.com/96boards/documentation/blob/master/consumer/b2260/additional-docs/images/images-board/sd/ST_B2260_Front_SD.png?raw=true" data-canonical-src="https://github.com/96boards/documentation/blob/master/consumer/b2260/additional-docs/images/images-board/sd/ST_B2260_Front_SD.png?raw=true" width="200" height="200" /><br> **B2260** | Board based on the Cannes2-STiH410 SoC | [Documentation](b2260/)<br> |
{:.table}

</div>
2 changes: 1 addition & 1 deletion consumer/dragonboard/dragonboard410c/vendor-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Discover our list of community and vendor sponsored DragonBoard 410c documents.

## On Qualcomm Developer Network

{% include image.html name="qc_developer_network.png" alt="Qualcomm Developer Network Image" %}
{% include image.html path="/assets/images/content/qc_developer_network.png" alt="Qualcomm Developer Network Image" %}

- [Qualcomm Developer Network](https://developer.qualcomm.com/hardware/dragonboard-410c/tools)
- [Android Release Notes](https://developer.qualcomm.com/download/db410c/android_release_notes-LM80-P0436-12_Rev_G.pdf)
Expand Down
4 changes: 3 additions & 1 deletion enterprise/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ redirect_from:
- /documentation/EnterpriseEdition/README.md/
- /documentation/EnterpriseEdition/
- /documentation/enterprise/README.md
toc: false
---
Welcome to the official documentation for 96Boards, this documentation is written by the 96Boards team at Linaro with community contribution and links to third party material.

Select your Enterprise Edition 96Boards device to access all product related resources
<div style="overflow-x:scroll;" markdown="1">
<div class="table-responsive" markdown="1">

| 96Boards | About | Options |
|:---------------------------------------:|:-------------------------------------------:|:---------------------------------------------:|
Expand All @@ -19,6 +20,7 @@ Select your Enterprise Edition 96Boards device to access all product related res
| <img src="poplar/additional-docs/images/images-board/sd/poplar-front-sd.png" data-canonical-src="poplar/additional-docs/images/images-board/sd/poplar-front-sd.png" width="220" height="180" /><br> **Poplar** | Board based on HiSilicon Hi3798C V200 | [Documentation](poplar/)<br> |
| <img src="poplar-hoperun/additional-docs/images/images-board/sd/poplar-front-sd.png" data-canonical-src="poplar-hoperun/additional-docs/images/images-board/sd/poplar-front-sd.png" width="220" height="180" /><br> **Hoperun Poplar** | Board based on HiSilicon Hi3798C V200 | [Documentation](poplar-hoperun/)<br> |
| <img src="oxalis/additional-docs/images/images-board/sd/oxalis-front-sd.JPG" data-canonical-src="oxalis/additional-docs/images/images-board/sd/oxalis-front-sd.JPG" width="220" height="180" /><br> **Oxalis** | Board Based on NXP Layerscape LS1012A | [Documentation](oxalis/)<br> |
{:.table}

</div>

Expand Down
4 changes: 3 additions & 1 deletion iot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,20 @@ redirect_from:
- /documentation/iot/README.md/
- /documentation/IoTEdition/README.md/
- /documentation/IoTEdition/
toc: false
---
Welcome to the official documentation for IoT Edition 96Boards, these documents are written by the [96Boards](https://www.96boards.org) team at [Linaro](http://www.linaro.org) with community contributions and links to third-party content.

Select your IoT Edition 96Boards device to access all product related resources

<div style="overflow-x:scroll;" markdown="1">
<div class="table-responsive" markdown="1">

| 96Boards | About | Options |
|:----------------------------------------:|:--------------------------------------------------------------------------:|:----------------------------------------:|
| <img src="https://github.com/96boards/documentation/blob/master/iot/wistrio/additional-docs/images/images-board/sd/wistrio-antenna-sd-front.png?raw=true" data-canonical-src="https://github.com/96boards/documentation/blob/master/iot/wistrio/additional-docs/images/images-board/sd/wistrio-antenna-sd-front.png?raw=true" width="200" height="100" /><br> **WisTrio** | Board based on the RAK5205 | [Documentation](wistrio/)<br> |
| <img src="https://github.com/sdrobertw/documentation/blob/master/iot/carbon/additional-docs/images/images-board/sd/carbon-front-sd.png?raw=true" data-canonical-src="https://github.com/sdrobertw/documentation/blob/master/iot/carbon/additional-docs/images/images-board/sd/carbon-front-sd.png?raw=true" width="200" height="100" /><br> **Carbon** | Board based on the STM32F401RE Processor and <br>nRF51822 <em>Bluetooth</em>® wireless technology controller | [Documentation](carbon/)<br> |
| <img src="https://github.com/sdrobertw/documentation/blob/master/iot/nitrogen/additional-docs/images/images-board/sd/nitrogen-front-sd.png?raw=true" data-canonical-src="https://github.com/sdrobertw/documentation/blob/master/iot/nitrogen/additional-docs/images/images-board/sd/nitrogen-front-sd.png?raw=true" width="200" height="100" /><br> **Nitrogen** | Board based on the nRF52832 microcontroller | [Documentation](nitrogen/)<br> |
| <img src="https://github.com/96boards/documentation/blob/master/iot/orangepi-i96/additional-docs/images/images-board/sd/orangepi-i96-front-sd.png?raw=true" data-canonical-src="https://github.com/96boards/documentation/blob/master/iot/orangepi-i96/additional-docs/images/images-board/sd/orangepi-i96-front-sd.png?raw=true" width="200" height="100" /><br> **Orange Pi i96** | Board based on the RDA8810PL ARM Cortex-A5 | [Documentation](orangepi-i96/)<br>(beta) |
{:.table}

</div>
4 changes: 3 additions & 1 deletion mezzanine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
title: Mezzanine Edition Documentation
permalink: /documentation/mezzanine/
redirect_from: /documentation/mezzanine/README.md/
toc: false
---
Mezzanine Design Guidelines ([View](https://github.com/96boards/documentation/blob/master/mezzanine/files/mezzanine-design-guidelines.pdf) / [Download](https://github.com/96boards/documentation/raw/master/mezzanine/files/mezzanine-design-guidelines.pdf))

<div style="overflow-x:scroll;" markdown="1">
<div class="table-responsive" markdown="1">

| 96Boards | About | Options |
|:------------------------------------------------:|:------------------------------------------------------:|:----------------------------------------------------:|
Expand All @@ -22,5 +23,6 @@ Mezzanine Design Guidelines ([View](https://github.com/96boards/documentation/bl
| <img src="neonkey/neonkey-front-sd.JPG" data-canonical-src="neonkey/neonkey-front-sd.JPG" width="200" height="85" /><br> **NeonKey** | Neonkey is the sensor hub platform for all 96Boards compliant family products | [Documentation](/documentation/mezzanine/neonkey/)<br> |
| <img src="https://www.96boards.org/product/mezzanine/arrow-nextbio/images/nextbio-back-sd.jpg?raw=true" data-canonical-src="https://www.96boards.org/product/mezzanine/arrow-nextbio/images/nextbio-back-sd.jpg?raw=true" width="200" height="85" /><br> **NEXTBiometrics Fingerprint Sensor Mezzanine** | The NB-2023-S2 shield board with assembled NB-2023-S2-VAIX (SPI) fingerprint module is a fingerprint development shield for the DragonBoard 410c development board by Arrow Electronics. | [Documentation](/documentation/mezzanine/arrow-nextbio/)<br> |
| <img src="https://www.96boards.org/product/mezzanine/shiratech-lte/images/shiratech-lte-front-sd.jpg?raw=true" data-canonical-src="https://www.96boards.org/product/mezzanine/shiratech-lte/images/shiratech-lte-front-sd.jpg?raw=true" width="200" height="85" /><br> **Shiratech LTE and Sensors Mezzanine** | Shiratech LTE and Sensor Mezzanine adds LTE modem functionality and a set of sensors to any 96Boards compatible board | [Documentation](/documentation/mezzanine/shiratech-lte/)<br> |
{:.table}

</div>
5 changes: 4 additions & 1 deletion som/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@
title: SoM Edition Documentation
permalink: /documentation/som/
redirect_from: /documentation/som/README.md/
toc: false
---
The SoM Edition (SoM) (Wireless and Compute) is a 96Boards specification which encourages the development of reliable and cost-effective embedded platforms for building end-products.

<div style="overflow-x:scroll;" markdown="1">
<div class="table-responsive" markdown="1">

| 96Boards | About | Options |
|:------------------------------------------------:|:------------------------------------------------------:|:----------------------------------------------------:|
| **96Boards SoM Carrier Board** | The 96Boards SoM Carrier Board is an Interface debugging and testing carrier board. | [Documentation](/documentation/som/96boards-som-carrier-board/) |
| **TB-96AI** | TB-96AI is a powerful core board for artificial intelligence. | [Documentation](/documentation/som/tb-96ai/) |
| **TB-96AIoT** | TB-96AIoT is a low-power, high-powered core board for the AIoT field. | [Documentation](/documentation/som/tb-96aiot/)<br> |
{:.table}

</div>

0 comments on commit f35cfd9

Please sign in to comment.