Skip to content

Commit 69c5e03

Browse files
evilnickurish
authored andcommitted
more descriptions
1 parent c0eff33 commit 69c5e03

File tree

8 files changed

+25
-4
lines changed

8 files changed

+25
-4
lines changed

docs/diagram-format.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: diagram.json File Format
33
sidebar_label: diagram.json
4+
description: Reference guide for the `diagram.json` file for Wokwi simulation projects. This file defines components, their attributes, layout positions, and the connections between them.
5+
keywords: [diagram.json, connections, wiring, component layout, virtual hardware, ESP32, STM32, Arduino, wire placement, simulation diagram, simulation editor]
46
---
57

68
Each simulation project contains a diagram.json file. This file defines the components

docs/gdb-debugging.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: GDB Debugging (Advanced)
33
sidebar_label: GDB Debugging
4+
description: Use GDB to debug Arduino and Raspberry Pi Pico code directly in the Wokwi simulator. This guide describes how to launch a web-based GDB session, step through code, set breakpoints and inspect variables.
5+
keywords: [GDB, debugging, Arduino, Raspberry Pi Pico, web gdb, gdb commands, breakpoint, gdb cheatsheet, sketch.ino, step-through debugging, avr debugging]
46
---
57

68
GDB is a powerful source code debugger. You can use it to debug your Arduino and Raspberry Pi Pico code in Wokwi.

docs/wokwi-ci/automation-scenarios.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Wokwi Automation Scenarios
33
sidebar_label: Automation Scenarios
4+
description: Automate simulations in Wokwi using YAML-based automation scenarios. Simulate button presses, sensor input, and verify serial output to test firmware programmatically.
5+
keywords: [automation, simulation testing, YAML automation scenarios, embedded simulation, automated firmware testing, sensor state simulation]
46
---
57

68
Automation scenarios allow you to automate the simulation, push buttons, change the state of the sensors, and check the serial output. You can use automation scenarios to test your firmware in a realistic environment, and verify that it behaves as expected.

docs/wokwi-ci/cli-installation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Wokwi CLI Installation
33
sidebar_label: CLI Installation
4+
description: Install the CLI to run and automate Wokwi simulations from your terminal.
5+
keywords: [CLI, terminal, CI, Powershell, wokwi-cli]
46
---
57

68
The CLI allows you to run Wokwi simulations from your terminal, and integrate them with your CI system. We recommend using the [Wokwi for VS Code](../vscode/getting-started) extension for local development, and the CLI for running your tests on CI.

docs/wokwi-ci/cli-usage.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Wokwi CLI Usage
33
sidebar_label: CLI Usage
4+
description: Wokwi CLI command reference
5+
keywords: [ reference, Wokwi, CLI, API, CI Dashboard, serial monitor]
46
---
57

68
Create an API token on the [Wokwi CI Dashboard](https://wokwi.com/dashboard/ci). Set the `WOKWI_CLI_TOKEN` environment variable to the token value.

docs/wokwi-ci/getting-started.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
title: Wokwi for CI and GitHub Actions
33
sidebar_label: Introduction
4+
description: Use Wokwi CI to automate embedded firmware testing in continuous integration workflows like GitHub Actions and GitLab CI. Learn about WITL (Wokwi in the Loop), automation scenarios, simulation limits, and integrating with AI agents using MCP.
5+
6+
keywords: [Wokwi CI, embedded testing, continuous integration, GitHub Actions, GitLab CI, firmware simulation, automation scenarios, Wokwi CLI, WITL, Model Context Protocol, MCP, AI-assisted development, simulation limits, embedded workflows]
47
---
58

69
Wokwi provides a robust simulation solution for automated testing of your embedded firmware on CI systems like [GitHub Actions](./github-actions), GitLab CI, and others. You can use Wokwi to run your tests on every commit, and get instant feedback on your code changes.

docs/wokwi-ci/github-actions.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Using Wokwi in GitHub Actions
33
sidebar_label: Github Actions
4+
description: Integrate Wokwi CI with GitHub Actions to automatically test your embedded firmware on every commit.
5+
keywords: [GitHub Actions, embedded testing, firmware automation, CI/CD, automation scenarios, CI workflows, embedded projects, continuous integration]
46
---
57

68
You can use Wokwi CI with GitHub Actions to run your tests on every commit. You need to have a workflow that builds your project's firmware. Add the following step to your workflow:
@@ -16,7 +18,7 @@ You can use Wokwi CI with GitHub Actions to run your tests on every commit. You
1618
1719
For a complete list of options, check out the [action's README](https://github.com/wokwi/wokwi-ci-action?tab=readme-ov-file#usage).
1820
19-
## CLI Tokens
21+
## CLI tokens
2022
2123
You also need to set up the `WOKWI_CLI_TOKEN` secret in your repository settings. You can create an API token on the [Wokwi CI Dashboard](https://wokwi.com/dashboard/ci).
2224

docs/wokwi-ci/mcp-support.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
# MCP Support
1+
---
2+
title: Model Context Protocola (MCP) support
3+
sidebar_label: MCP support
4+
description: Integrate AI agents like Copilot, Claude, Cursor, Gemini, and ChatGPT with Wokwi using the Model Context Protocol (MCP). This guide covers configuring the Wokwi MCP server, enabling real-time simulation, automated testing, and virtual hardware interaction.
5+
keywords: [MCP, Model Context Protocol, AI integration, Copilot, Claude, ChatGPT, Gemini, Cursor, automated testing, serial console]
6+
---
7+
28

3-
## What is MCP?
9+
# MCP Support
410

5-
The Model Context Protocol (MCP) is an open standard that allows AI agents—such as Copilot, Claude Code, Cursor, and others to securely interact with external tools and services. For Wokwi users, MCP enables seamless integration between AI assistants and embedded simulation.
11+
The Model Context Protocol (MCP) is an open standard that allows AI agents—such as Copilot, Claude Code, Cursor, Gemini, ChatGPT and others to securely interact with external tools and services. For Wokwi users, MCP enables seamless integration between AI assistants and embedded simulation.
612

713
## Wokwi MCP Server
814

0 commit comments

Comments
 (0)