From f35cfd9b071e9bd44a4251f67464629832bd257c Mon Sep 17 00:00:00 2001 From: Kyle Date: Fri, 27 Nov 2020 11:14:24 +0000 Subject: [PATCH] Updates to documentation for new website theme implementation (#912) * 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 --- README.md | 6 ++++-- Specifications/README.md | 1 + consumer/README.md | 4 +++- consumer/dragonboard/dragonboard410c/vendor-docs/README.md | 2 +- enterprise/README.md | 4 +++- iot/README.md | 4 +++- mezzanine/README.md | 4 +++- som/README.md | 5 ++++- 8 files changed, 22 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 96123a145..9ae025e6e 100644 --- a/README.md +++ b/README.md @@ -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. @@ -13,7 +14,7 @@ Select your platform for a list of supported products (left), or jump to 96Board - [96Boards Guides](guides/) - [Contribute to this repository](CONTRIBUTE.md) -
+
| Platform | Description | Boards | |:---------------------------------------:|:-------------------------------------------:|:-------------------------------------------| @@ -21,7 +22,8 @@ Select your platform for a list of supported products (left), or jump to 96Board | [**Consumer Edition**](consumer/)
[](consumer/)
| These small, low-cost, and low-power consumer 96Boards
are great for developers, makers, and hobbyists! | [View Boards](consumer/)
[Guides](consumer/guides/)
[Compare](consumer/guides/compare_96boards_ce.md) | | [**Enterprise Edition**](enterprise/)
[](enterprise/)| These powerful, reliable, ARM based 96Boards boards are
ideal targets for networking and server segments| [View Boards](enterprise/)
| | [**Mezzanine**](mezzanine/)
[](mezzanine/) | Expand on all 96Boards with new interfaces for IoT,
industrial control, and other embedded applications. | [View Boards](mezzanine/) | - +{:.table} +#
*** diff --git a/Specifications/README.md b/Specifications/README.md index 1c10030f9..eaa191c99 100644 --- a/Specifications/README.md +++ b/Specifications/README.md @@ -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 diff --git a/consumer/README.md b/consumer/README.md index 4e4ce73ad..0dd5b030f 100644 --- a/consumer/README.md +++ b/consumer/README.md @@ -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. @@ -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/) -
+
| 96Boards | About | Options | |:------------------------------------------------:|:------------------------------------------------------:|:--------------------------:| @@ -36,5 +37,6 @@ Select your Consumer Edition 96Boards device to access all product specific reso
**MediaTek X20** | Board based on MediaTek X20 Applications Processor | [Documentation](mediatekx20/)
| |
**MediaTek X20 Pro** | Board based on MediaTek X20 Applications Processor | [Documentation](mediatekx20pro/)
| |
**B2260** | Board based on the Cannes2-STiH410 SoC | [Documentation](b2260/)
| +{:.table}
diff --git a/consumer/dragonboard/dragonboard410c/vendor-docs/README.md b/consumer/dragonboard/dragonboard410c/vendor-docs/README.md index 89b40572d..1e0f627ae 100644 --- a/consumer/dragonboard/dragonboard410c/vendor-docs/README.md +++ b/consumer/dragonboard/dragonboard410c/vendor-docs/README.md @@ -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) diff --git a/enterprise/README.md b/enterprise/README.md index 2c5978361..da23bf446 100644 --- a/enterprise/README.md +++ b/enterprise/README.md @@ -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 -
+
| 96Boards | About | Options | |:---------------------------------------:|:-------------------------------------------:|:---------------------------------------------:| @@ -19,6 +20,7 @@ Select your Enterprise Edition 96Boards device to access all product related res |
**Poplar** | Board based on HiSilicon Hi3798C V200 | [Documentation](poplar/)
| |
**Hoperun Poplar** | Board based on HiSilicon Hi3798C V200 | [Documentation](poplar-hoperun/)
| |
**Oxalis** | Board Based on NXP Layerscape LS1012A | [Documentation](oxalis/)
| +{:.table}
diff --git a/iot/README.md b/iot/README.md index 92813c8a6..6ead900b3 100644 --- a/iot/README.md +++ b/iot/README.md @@ -5,12 +5,13 @@ 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 -
+
| 96Boards | About | Options | |:----------------------------------------:|:--------------------------------------------------------------------------:|:----------------------------------------:| @@ -18,5 +19,6 @@ Select your IoT Edition 96Boards device to access all product related resources |
**Carbon** | Board based on the STM32F401RE Processor and
nRF51822 Bluetooth® wireless technology controller | [Documentation](carbon/)
| |
**Nitrogen** | Board based on the nRF52832 microcontroller | [Documentation](nitrogen/)
| |
**Orange Pi i96** | Board based on the RDA8810PL ARM Cortex-A5 | [Documentation](orangepi-i96/)
(beta) | +{:.table}
diff --git a/mezzanine/README.md b/mezzanine/README.md index a00b9d986..cee38a4cc 100644 --- a/mezzanine/README.md +++ b/mezzanine/README.md @@ -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)) -
+
| 96Boards | About | Options | |:------------------------------------------------:|:------------------------------------------------------:|:----------------------------------------------------:| @@ -22,5 +23,6 @@ Mezzanine Design Guidelines ([View](https://github.com/96boards/documentation/bl |
**NeonKey** | Neonkey is the sensor hub platform for all 96Boards compliant family products | [Documentation](/documentation/mezzanine/neonkey/)
| |
**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/)
| |
**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/)
| +{:.table}
diff --git a/som/README.md b/som/README.md index a038759e1..f25fdbd0d 100644 --- a/som/README.md +++ b/som/README.md @@ -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. -
+
| 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/)
| +{:.table} +