Skip to content

Commit eb82ae9

Browse files
committed
Really dirty
1 parent 531525f commit eb82ae9

File tree

25 files changed

+31
-31
lines changed

25 files changed

+31
-31
lines changed

docs/api/light-control.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="light-control">Light control tutorial</h2>
1+
<h1 id="light-control">Light control tutorial</h1>
22

33
The application below demonstrates a simple light control application, where devices can control the LED status of all devices in the network. You can build the application for the unsecure 6LoWPAN-ND or Thread network.
44

docs/api/lorawan/loraradio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="loraradio-api">LoRa radio driver</h2>
1+
<h1 id="loraradio-api">LoRa radio driver</h1>
22

33
`LoRaRadio` is a pure virtual class that defines APIs for a LoRa radio driver.
44

docs/api/networkinterfaces/CellularInterface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="cellular-api">Cellular API</h2>
1+
<h1 id="cellular-api">Cellular API</h1>
22

33
<span class="images">![](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_cellular_interface.png)<span>CellularInterface class hierarchy</span></span>
44

docs/api/networkinterfaces/MeshInterface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="mesh-api">Mesh</h2>
1+
<h1 id="mesh-api">Mesh</h1>
22

33
<span class="images">![](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_mesh_interface.png)<span>MeshInterface class hierarchy</span></span>
44

docs/api/networkinterfaces/NetworkStatus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="network-status">Network status</h2>
1+
<h1 id="network-status">Network status</h1>
22

33
This interface informs you about connection state changes asynchronously. Providing a method to register a callback function to a socket accomplishes this. Each time the network interface's state changes, it triggers the callback.
44

docs/api/networkinterfaces/ethernet-arch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="ethernet-technology">Ethernet</h2>
1+
<h1 id="ethernet-technology">Ethernet</h1>
22

33
The term **Ethernet** refers to technologies first introduced in 1980 and standardized in 1983 as **IEEE 802.3**. Ethernet is a wired network, usually implemented by twisted pair wiring, or optical fiber and coaxials. However, coaxial has largely become obsolete.
44

docs/api/networkinterfaces/mesh-arch/6lowpan_nd_intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="6LoWPAN-ND-tech">6LoWPAN-ND</h2>
1+
<h1 id="6LoWPAN-ND-tech">6LoWPAN-ND</h1>
22

33
6LoWPAN-ND (IPv6 over Low-Power Wireless Personal Area Networks with Neighbor Discovery) is a mesh protocol that loosely follows the [Zigbee-IP](https://www.zigbee.org/) specification. 6LoWPAN-ND allows IP-based networking to all nodes in the network.
44

docs/api/networkinterfaces/mesh-arch/thread_commissioning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="thread-commissioning">How to commission a Thread device in practice</h2>
1+
<h1 id="thread-commissioning">How to commission a Thread device in practice</h1>
22

33
## Requirements
44

docs/api/networkinterfaces/mesh-arch/wisun_intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="wisun-tech">Wi-SUN</h2>
1+
<h1 id="wisun-tech">Wi-SUN</h1>
22

33
The Wi-SUN Field Area Network (FAN) is based on open standards from IEEE802, IETF, ANSI/TIA and ETSI.
44

docs/api/networkinterfaces/wifi-arch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="wlan-technology">Wireless LAN</h2>
1+
<h1 id="wlan-technology">Wireless LAN</h1>
22

33
One of the most popular connectivity technologies is Wireless LAN (Wireless Fidelity - Wi-Fi) as standardized in IEEE 802.11. It extends the Ethernet standards by making Ethernet wireless and adding required security.
44

docs/api/networksocket/networksocket.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="network-socket">Network socket overview</h2>
1+
<h1 id="network-socket">Network socket overview</h1>
22

33
The application programming interface for IP networking is the Socket API. As described in the [IP networking](../reference/ip-networking.html) section, the Socket API relates to OSI layer 4, the Transport layer. In Mbed OS, the Socket API is abstract and supports various protocols such as TCP, UDP and non-IP data delivery for NB-IoT cellular networks.
44

docs/api/platform/Error.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="error-handling">Error handling</h2>
1+
<h1 id="error-handling">Error handling</h1>
22

33
Mbed OS provides error status definitions and APIs for error construction, reporting and retrieving previously reported errors. Mbed OS also provides functions and macros to generate and define new error status values, extract information from error status values and to report errors into the system. Any software layer, such as applications, drivers, HAL and protocol stacks, can use these error handling APIs. The error functions also facilitate emitting an error message through STDOUT. `mbed_error.h` declares the error functions that Mbed OS provides.
44

docs/api/rtos/rtos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="rtos-api">RTOS overview</h2>
1+
<h1 id="rtos-api">RTOS overview</h1>
22

33
The Mbed OS RTOS capabilities include managing objects such as threads, synchronization objects and timers. It also provides interfaces for attaching an application-specific idle hook function, reads the OS tick count and implements functionality to report RTOS errors.
44

docs/api/security/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="psa-api">The Mbed implementation of PSA</h2>
1+
<h1 id="psa-api">The Mbed implementation of PSA</h1>
22

33
The Mbed implementation of the Platform Security Architecture (PSA) provides root of trust services and infrastructure for developing IoT applications.
44

docs/api/storage/storage-arch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="storage-tech">Architecture</h2>
1+
<h1 id="storage-tech">Architecture</h1>
22

33
The architecture of the Mbed OS storage solution has the following properties:
44

docs/api/storage/storage-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="storage-config">Configuration</h2>
1+
<h1 id="storage-config">Configuration</h1>
22

33
This page describes the build-time configurable parameters for storage in Mbed OS:
44

docs/api/storage/storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="storage-api">Storage overview</h2>
1+
<h1 id="storage-api">Storage overview</h1>
22

33
The storage APIs present in Arm Mbed OS are:
44

docs/api/usb/usb_component.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="usb-overview">USB components overview</h2>
1+
<h1 id="usb-overview">USB components overview</h1>
22

33
The Universal Serial Bus (USB) is the most widely used bus in today's computer. USB has been designed to standardize connections between the computer and peripherals. For example, keyboards, mice, USB audio devices, printers, scanners, disk drives and cameras can use the same bus to exchange data with a computer.
44

docs/contributing/guidelines/ci.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="ci">Continuous integration (CI) testing</h2>
1+
<h1 id="ci">Continuous integration (CI) testing</h1>
22

33
Continuous integration (CI) testing is an integral part of the Mbed OS contribution workflow. CI testing refers mainly to automatic testing for pull requests.
44

docs/introduction/introduction.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Mbed OS is an open-source operating system for platforms using Arm microcontroll
44

55
<section class="row">
66
<div class="columns large-6 medium-6 small-12">
7-
<h2>On this page</h2>
7+
<h2>On this page</h1>
88
<ul class="guides-list">
99
<ul data-tab-content>
1010
<li><a href="#getting-started">Getting Started</a></li>
@@ -18,18 +18,18 @@ Mbed OS is an open-source operating system for platforms using Arm microcontroll
1818
</div>
1919
</section>
2020

21-
<h2 id="getting-started">Getting started</h2>
21+
<h1 id="getting-started">Getting started</h1>
2222

2323
If you want to dive straight in:
2424

2525
- The source code is available on [GitHub](https://github.com/ARMmbed/mbed-os) and on our [release page](https://os.mbed.com/releases/).
2626
- Or [try our quick start](../quick-start/index.html).
2727

28-
<h2 id="licensing">Source code and licensing</h2>
28+
<h1 id="licensing">Source code and licensing</h1>
2929

3030
We release Mbed OS under an Apache 2.0 license, so you can confidently use it in commercial and personal projects. For more information about licensing, please see [our licensing documentation](../contributing/license.html).
3131

32-
<h2 id="architecture">Architecture diagram</h2>
32+
<h1 id="architecture">Architecture diagram</h1>
3333

3434
This is the basic architecture of an Mbed board:
3535

@@ -77,15 +77,15 @@ Broadly speaking, the hardware you can see on our site is of three types:
7777
- **[Boards](https://os.mbed.com/platforms/)**: development boards are an inexpensive way to start developing with Mbed OS and other components.
7878
- **[Components](https://os.mbed.com/components/)**: the Component Database hosts reusable libraries for different hardware, middleware and IoT services that you can use with Arm Microcontrollers. These components can be used as building blocks for quickly developing prototypes and products.
7979

80-
<h2 id="tools">Tools</h2>
80+
<h1 id="tools">Tools</h1>
8181

8282
The Mbed product suite includes the tools you need to work with Mbed OS, whatever your skill level. If you are an experienced developer with a desktop setup, you may prefer working offline with Arm Mbed CLI, our Python-based command-line tool. You can use Mbed CLI with one of three supported toolchains: Arm Compiler 6, GCC and IAR. You can also [export projects](../tools/exporting.html) for other IDEs, such as Keil MDK. Mbed OS includes integration code for each supported toolchain to make it thread safe.
8383

8484
If you prefer to work online, use the Arm Mbed Online Compiler, our online development tool, which lets you write and build applications using a web browser with no additional setup.
8585

8686
You can use our debugging tools, DAPLink and pyOCD, to program and debug many devices. At the end of the development cycle, you can use the Mbed OS validation tools, Greentea and utest, to test your project.
8787

88-
<h2 id="the-docs">The documentation</h2>
88+
<h1 id="the-docs">The documentation</h1>
8989

9090
This is the technical documentation for Mbed OS. We have three types of documents: references, tutorials and porting guides. Our references are background technical material about our APIs, architecture and runtime execution. Our tutorials are step-by-step instructions that show you how to perform specific tasks and solve problems. Our porting guides show our silicon Partners how to port Mbed OS to their targets.
9191

@@ -100,7 +100,7 @@ Please see the following sections of our documentation for more information.
100100
- [Contributing](../contributing/index.html), guidelines about contributing to our open-source project.
101101
- [Porting guides](../porting/index.html), for Partners and developers interested in porting targets to Mbed OS.
102102

103-
<h2 id="docs-updates">Recently updated documentation</h2>
103+
<h1 id="docs-updates">Recently updated documentation</h1>
104104

105105
- A guide to [porting a custom board](../porting/porting-a-custom-board.html).
106106
- A porting guide for the [static pin map extension](../porting/static-pinmap-port.html).

docs/migrating/MINAR_migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="minar-migration">Migrating from MINAR (Arm Mbed OS 3)</h2>
1+
<h1 id="minar-migration">Migrating from MINAR (Arm Mbed OS 3)</h1>
22

33
If you're looking to migrate your Arm Mbed application from Mbed OS 3 to Arm Mbed OS 5, one of the first things you're likely to notice is that [MINAR](https://github.com/ARMmbed/minar) (the event schduler in Mbed OS 3) does not exist in Mbed OS 5. This might be inconvenient, but there are different strategies that you can apply to port your Mbed OS 3 application to Mbed OS 5. This document presents some of these strategies from the MINAR perspective.
44

docs/migrating/migrate-from-mbed-os-2-to-5.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,6 @@ Now, the program successfully compiles.
169169

170170
Although the program or library now compiles successfully, runtime errors may still be present. Please visit the [compile-time errors tutorial](compile-time-errors.html#runtime-errors-and-lights-of-the-dead) for further debugging tips about common errors.
171171

172-
<h2 id="enabling-bare-metal">Enabling Mbed OS bare metal</h2>
172+
<h1 id="enabling-bare-metal">Enabling Mbed OS bare metal</h1>
173173

174174
Enabling the Mbed OS bare metal profile allows you to build Mbed OS without an RTOS. To enable it, you have to complete the [migration to Mbed OS 5](#migrating-to-mbed-os-5). Once the migration is complete, you can enable Mbed OS bare metal by following the instructions in the [bare metal example](../reference/bare-metal-example-application.html).

docs/program-setup/bare_metal/c_small_libs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="using-small-c-libraries">Using small C libraries in Mbed OS bare metal</h2>
1+
<h1 id="using-small-c-libraries">Using small C libraries in Mbed OS bare metal</h1>
22

33
If your application does not use an RTOS, build it in the bare metal mode to achieve memory savings. Both the `ARM` and `GCC_ARM` toolchains support code optimized versions of their C standard libraries, `microlib` and `newlib-nano`. It is safe to use these smaller C libraries in bare metal mode, and we recommend using them.
44

docs/program-setup/runtime/Memory.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="memory-model">Memory</h2>
1+
<h1 id="memory-model">Memory</h1>
22

33
This is a basic overview of the memory model in Mbed OS.
44

docs/program-setup/serial/serial_communication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h2 id="serial-comm">Board to PC communication over USB</h2>
1+
<h1 id="serial-comm">Board to PC communication over USB</h1>
22

33
The Arm Mbed microcontroller on your board can communicate with a host PC over the same USB cable that you use for programming.
44

0 commit comments

Comments
 (0)