Skip to content

Commit 3d16d05

Browse files
Start on workflow
1 parent 745149f commit 3d16d05

File tree

4 files changed

+46
-3
lines changed

4 files changed

+46
-3
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Build and Deploy
2+
3+
on: [push]
4+
5+
jobs:
6+
build-and-deploy:
7+
runs-on: ubuntu-latest
8+
9+
steps:
10+
- uses: actions/checkout@v4
11+
- uses: actions/setup-python@v5
12+
with:
13+
python-version: '3.13'
14+
- name: Create Venv for Mkdocs
15+
run: |
16+
python3 -m venv .venv
17+
source .venv/bin/activate.sh
18+
pip install -r requirements.txt
19+
- name: Build Site
20+
run: |
21+
mkdocs build

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
# Generated site
3+
site/
4+
5+
# Python venv
6+
.venv/
7+
venv/

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Mbed CE Documentation Website (mbed-ce.dev)
2+
3+
This is a docs website built with [mkdocs](https://www.mkdocs.org/) and [mkdocs-material](https://squidfunk.github.io/mkdocs-material/).
4+
5+
## Building Locally
6+
1. Create a python 3 venv, activate it, and install requirements.txt
7+
2. To build the site to HTML files, run
8+
```
9+
$ mkdocs build
10+
```
11+
3. Or, to serve the current site, watching for changes, run
12+
```
13+
$ mkdocs serve
14+
```

docs/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# What is Mbed OS CE?
1+
# Mbed OS Community Edition
2+
## What is Mbed OS?
23

34
Mbed OS is an embedded real-time operating system (RTOS) and hardware abstraction layer (HAL) written in C/C++ that runs across a wide range of ARM microcontrollers (MCUs). Mbed OS can run on chips as small as 16k RAM / 64k flash, but also scales up to ones with megabytes of RAM and flash. Mbed OS is designed for Internet of Things (IoT) applications, and as such supports wired and wireless network connectivity, Internet protocols, and network encryption.
45

@@ -131,11 +132,11 @@ Below is the list of supported microcontroller families, by manufacturer. In gen
131132
| Samsung | S1SBP6A |
132133
| Toshiba | TX04 M460, TXZ+ M4G, TXZ+ M4K, TXZ+ M4N |
133134

134-
## Mbed Community Edition
135+
## Why Mbed Community Edition?
135136

136137
This site is for Mbed OS Community Edition, or Mbed CE for short. Mbed CE is a community-led continuation of the Mbed OS project after its abandonment by ARM. Anyone can contribute features, bugfixes, or even new targets to Mbed CE -- visit the repository linked in the header for the source code!
137138

138-
### Differences from Mbed OS 6
139+
## Differences from Mbed OS 6
139140

140141
At Mbed CE, we are proud to have made a number of improvements from ARM Mbed OS 6.
141142

0 commit comments

Comments
 (0)