Skip to content

Commit c0eff33

Browse files
evilnickurish
authored andcommitted
add frontmatter and keywords to some pages
1 parent 5f2bab1 commit c0eff33

15 files changed

+42
-6
lines changed

docs/guides/circuitpython.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: CircuitPython on Wokwi
33
sidebar_label: CircuitPython
4+
description: Simulate CircuitPython on Wokwi using the Raspberry Pi Pico. This guide covers project setup, using Adafruit libraries, and exploring the CircuitPython REPL.
5+
keywords: [CircuitPython, Wokwi, Raspberry Pi Pico, CircuitPython simulation, CircuitPython REPL, Adafruit CircuitPython, embedded Python, Wokwi tutorial]
46
---
57

68
You can simulate CircuitPython on Wokwi using the [Raspberry Pi Pico board](../parts/wokwi-pi-pico). To start a new simulation project, open the [Raspberry Pi Pico CircuitPython project template](https://wokwi.com/projects/new/circuitpython-pi-pico).

docs/guides/debugger.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
1-
# Interactive Debugger
1+
---
2+
title: Interactive debugger
3+
sidebar_label: Interactive debugger
4+
description: Use Wokwi's built-in interactive debugger to step through code, set breakpoints, inspect variables, and explore call stacks.
5+
keywords: [Wokwi debugger, interactive debugger, Arduino debug, step through, breakpoints]
6+
---
7+
8+
9+
# Interactive debugger
210

311
Wokwi has a built-in debugger that allows you to step through your code, inspect variables, and set breakpoints. The debugger is currently in beta, and is available for AVR microcontrollers: Arduino Uno, Arduino Nano, Arduino Mega, and the ATtiny85.
412

5-
If you wish to debug other microcontrollers, such as the ESP32 or the Raspberry Pi Pico, you can use [Wokwi for VSCode](../vscode/getting-started), which has an [integrated debugger support](../vscode/debugging).
13+
If you wish to debug other microcontrollers, such as the ESP32 or the Raspberry Pi Pico, you can use [Wokwi for VSCode](../vscode/getting-started), which has [integrated debugger support](../vscode/debugging).
614

7-
## Using the Debugger
15+
## Using the debugger
816

917
To start debugging your code, click the menu button in the simulator toolbar, and select **Debug**:
1018

@@ -22,11 +30,11 @@ When running in debug mode, you will see the debug toolbar above the code editor
2230

2331
- **Step out** - Step out of the current function.
2432

25-
## Debugging Panes
33+
## Debugging panes
2634

2735
The debugging panes appear when you pause the program (either manually, or at a breakpoint). You'll find the panes below the diagram, next to the [Serial Monitor](./serial-monitor) pane.
2836

29-
### Call Stack
37+
### Call stack
3038

3139
The call stack shows the current function call stack. The top of the stack is the currently executing function. The bottom of the stack is the main function.
3240

docs/guides/diagram-editor.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
---
22
title: Interactive Diagram Editor
33
sidebar_label: Diagram Editor
4+
description: Use the Wokwi Diagram Editor to visually build and edit circuit simulations. Add components, wire connections, rotate, duplicate, and manage parts with the help of intuitive keyboard shortcuts and grid snapping.
5+
keywords: [Wokwi diagram editor, diagram.json, visual circuit builder]
6+
47
---
58

6-
The diagram editor provides an interactive way to edit your diagram: add components to the simulation and define the connections between them. It's a convenient alternative for editing the [diagram.json](../diagram-format) file directly.
9+
The diagram editor provides an interactive way to edit your circuit diagram: add components to the simulation and define the connections between them. It's a convenient alternative for editing the [diagram.json](../diagram-format) file directly.
710

811
## Editing parts
912

docs/guides/esp32-wifi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: ESP32 WiFi Networking
33
sidebar_label: ESP32 WiFi
4+
description: Simulate WiFi and internet access for ESP32 projects using Wokwi, including public/private gateways, HTTP/MQTT, and local networking.
5+
keywords: [ ESP32, WiFi, IoT, MQTT, Private Gateway, MicroPython, Arduino]
46
---
57

68
Wokwi simulates a WiFi network with full internet access. You can use the [ESP32](./esp32) together with the virtual WiFi to prototype IoT projects. Common use cases include:

docs/guides/esp32.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: ESP32 Simulation
33
sidebar_label: ESP32 Simulator
4+
description: Simulate espressif ESP32 boards in Wokwi
5+
keywords: [ESP32, ESP32 Simulation, ESP32, ESP32-C3, ESP32-S2, ESP32-S3, ESP32-C6, ESP32-H2, MicroPython, Arduino, Rust, IoT, VSCode, ESP-IDF]
46
---
57

68
The ESP32 is a popular WiFi and Bluetooth-enabled microcontroller, widely used for IoT Projects. Wokwi simulates the ESP32, ESP32-C3, ESP32-S2, ESP32-S3, ESP32-C6, ESP32-H2, and ESP32-P4 (beta).

docs/guides/libraries.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Arduino Libraries
33
sidebar_label: Libraries
4+
description: Add built-in, third-party, and custom Arduino libraries to your Wokwi projects using the Library Manager and the libraries.txt file.
5+
keywords: [Arduino libraries, Library Manager, libraries.txt, custom libraries, upload library, Arduino Library Manager, Arduino includes]
46
---
57

68
To include a library, go to the code editor and type `#` on an empty line. You'll see a autocomplete dropdown with `#include` suggestions for popular libraries.

docs/guides/logic-analyzer.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Logic Analyzer Guide
33
sidebar_label: Logic Analyzer
4+
description: Use the Wokwi Logic Analyzer to debug and visualize digital signals, record VCD files, and analyze protocols using PulseView or GTKWave.
5+
keywords: [Logic Analyzer, Wokwi, VCD file, PulseView, GTKWave, I2C debugging, PWM, PIO, Raspberry Pi Pico, downsampling]
46
---
57

68
import LogicAnalyzerI2CImage from './logic-analyzer-i2c-decoder.png';

docs/guides/micropython.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: MicroPython on Wokwi
33
sidebar_label: MicroPython
4+
description: Create and run MicroPython projects in Wokwi using the Raspberry Pi Pico simulator.
5+
keywords: [MicroPython, Wokwi, Raspberry Pi Pico, main.py, REPL, flash filesystem, MicroPython simulation]
46
---
57

68
You can create and run MicroPython projects on Wokwi. Start from the [Raspberry Pi Pico MicroPython project template](https://wokwi.com/projects/new/micropython-pi-pico).

docs/guides/serial-monitor.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: The Serial Monitor
33
sidebar_label: Serial Monitor
4+
description: Interact with the serial interface of the Wokwi simulation to view output or send data.
5+
keywords: [Serial, USART, TX, RX, Arduino]
46
---
57

68
The Serial Monitor provides a way to send/receive information to/from your Arduino code.

docs/guides/translating.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Translating Wokwi
33
sidebar_label: Translating
4+
description: Help to translate this documentation into the languages of the world.
45
---
56

67
This page explains how you can contribute translations to Wokwi.

0 commit comments

Comments
 (0)