Skip to content

Commit 15f0819

Browse files
authored
chore: clean root artifacts and normalize docs (#4)
1 parent d3b705b commit 15f0819

31 files changed

Lines changed: 46 additions & 132067 deletions

.gitignore

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Build output
2+
/target/
3+
/*.rlib
4+
5+
# Local release/test run outputs
6+
/final-release-verification/
7+
/release-demo/
8+
/release-ready-test/
9+
10+
# Local debug/lint artifacts
11+
/gdb_test.log
12+
/clippy_output.txt
13+
/*_error.log
14+
15+
# Generated root-level chip artifacts (keep source of truth under tests/configs)
16+
/advanced_stm32.json
17+
/advanced_stm32.rs
18+
/dummy_stm32.json
19+
/dummy_stm32.rs
20+
/nrf52832.json
21+
/nrf52832.rs
22+
/rp2040.json
23+
/rp2040.rs
24+
/stm32f401.json
25+
/stm32f401.rs
26+
/test_device.json
27+
/test_device.rs
28+
/demo_chip.rs

CHANGELOG.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1616
- Verified against STM32F4, RP2040, and nRF52.
1717
- **Timing Hooks**: Declarative peripheral behavior for registers (SetBits, ClearBits, WriteValue) with periodic and event-based triggers.
1818
- **Timeline View**: Professional visualization of instruction trace data in the VS Code extension.
19-
- **Support Strategy**: Defined **Tier 1 Device Support** (STM32F4, RP2040, nRF52) in `docs/SUPPORTED_DEVICES.md`.
20-
- **Architecture Guide**: New comprehensive `core/docs/ARCHITECTURE.md`.
19+
- **Support Strategy**: Defined **Tier 1 Device Support** (STM32F4, RP2040, nRF52) in `docs/release_strategy.md`.
20+
- **Architecture Guide**: New comprehensive `core/docs/architecture_guide.md`.
2121
- **SVD Ingestor**: New tool (`crates/svd-ingestor`) to generate `PeripheralDescriptor` YAMLs from SVD.
22-
- **Strategic Horizon**: Long-term vision integrated into `docs/plan.md`.
22+
- **Strategic Horizon**: Long-term vision integrated into `docs/release_strategy.md`.
2323

2424
## [0.11.0] - 2026-02-08
2525

@@ -28,7 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2828
- **Modeling**: Enabled peripheral definition via YAML descriptors using `labwired-config`.
2929
- **Simulation**: Implemented `GenericPeripheral` in `labwired-core` supporting dynamic MMR modeling, bitwise masking, and reset state.
3030
- **Integration**: Added support for `type: "declarative"` in chip descriptors, allowing zero-code peripheral additions.
31-
- **Documentation**: New [Peripheral Modeling Tutorial](file:///home/andrii/Projects/labwired/docs/tutorial_peripheral_modeling.md) for declarative IP cores.
31+
- **Documentation**: New [Peripheral Development Guide](./docs/peripheral_development.md) for declarative IP cores.
3232
- **ISA Extensions**:
3333
- **Misc Thumb-2**: Implemented `CLZ` (Count Leading Zeros), `RBIT` (Bit Reverse), `REV`, `REV16`, `REVSH` instructions.
3434
- **RISC-V Support**: Initial support for RV32I Base Integer Instruction Set with multi-arch GDB support.
@@ -60,8 +60,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6060
- **GDB Remote Serial Protocol**: New `labwired-gdbstub` crate allowing connection from standard GDB clients.
6161
- **Interactive Debugging (DAP)**: `labwired-dap` server for VS Code integration with variable and register inspection.
6262
- **Documentation**:
63-
- [Peripheral Development Guide](file:///home/andrii/Projects/labwired/docs/peripheral_development.md).
64-
- [Getting Started with Real Firmware](file:///home/andrii/Projects/labwired/docs/getting_started_firmware.md) onboarding guide.
63+
- [Peripheral Development Guide](./docs/peripheral_development.md).
64+
- [Getting Started with Real Firmware](./docs/getting_started_firmware.md) onboarding guide.
6565

6666
## [0.9.0] - 2026-02-04
6767

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,11 @@ We welcome contributions! Please see our community guides:
3434
Full setup guide: [Getting Started](./docs/getting_started_firmware.md)
3535

3636
## Documentation
37-
- [Architecture](./docs/architecture.md)
38-
- [CI Integration](./docs/ci_integration.md)
39-
- [GDB Integration](./docs/GDB_INTEGRATION.md)
37+
- [Architecture Overview](./docs/architecture.md)
38+
- [Architecture Guide](./docs/architecture_guide.md)
39+
- [CI Integration Guide](./docs/ci_integration.md)
40+
- [GDB Integration](./docs/gdb_integration.md)
41+
- [Release Strategy](./docs/release_strategy.md)
4042
- [VS Code Debugging](./docs/vscode_debugging.md)
4143

4244
## License

advanced_stm32.json

Lines changed: 0 additions & 113 deletions
This file was deleted.

advanced_stm32.rs

Lines changed: 0 additions & 8 deletions
This file was deleted.

clippy_output.txt

Lines changed: 0 additions & 123 deletions
This file was deleted.

demo_chip.rs

Lines changed: 0 additions & 4 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ To satisfy Rust's borrow checker and ensure determinism:
5555
2. **Resolution Phase**: The Bus processes these requests, modifying memory or triggering CPU exceptions.
5656

5757
## 3. Peripheral Modeling
58-
We prioritize **Tier 1 Devices** for deep support (see `docs/SUPPORTED_DEVICES.md`):
58+
We prioritize **Tier 1 Devices** for deep support (see `docs/release_strategy.md`):
5959
* **STM32F4** (Cortex-M4)
6060
* **RP2040** (Dual Cortex-M0+)
6161
* **nRF52** (Cortex-M4F)

docs/declarative_registers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ registers:
4949

5050
## Getting Started
5151

52-
See the [Peripheral Modeling Tutorial](file:///home/andrii/Projects/labwired/docs/tutorial_peripheral_modeling.md) for a step-by-step guide on creating your first declarative peripheral.
52+
See the [Peripheral Development Guide](./peripheral_development.md) for a step-by-step workflow to build your first declarative peripheral.

docs/examples/integrated_test_walkthrough.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ This example demonstrates how to use the `labwired test` runner to verify a real
44

55
## 1. The Building Blocks
66

7-
### Chip Descriptor ([stm32f103.yaml](file:///home/andrii/Projects/labwired/configs/chips/stm32f103.yaml))
7+
### Chip Descriptor ([stm32f103.yaml](../../configs/chips/stm32f103.yaml))
88
Defines the memory map and peripherals (DMA, EXTI, AFIO, UART).
99

10-
### System Manifest ([stm32f103-integrated-test.yaml](file:///home/andrii/Projects/labwired/configs/systems/stm32f103-integrated-test.yaml))
10+
### System Manifest ([stm32f103-integrated-test.yaml](../../configs/systems/stm32f103-integrated-test.yaml))
1111
Wires the chip into a specific system context. In this case, it just uses the raw chip.
1212

13-
### Firmware ([main.rs](file:///home/andrii/Projects/labwired/crates/firmware/src/main.rs))
13+
### Firmware ([main.rs](../../crates/firmware/src/main.rs))
1414
A Rust `no_std` firmware that:
1515
- Performs 32-bit division.
1616
- Configures DMA1 Channel 1 for a memory-to-memory transfer.
@@ -19,7 +19,7 @@ A Rust `no_std` firmware that:
1919

2020
## 2. The Test Script
2121

22-
The test script ([stm32f103_integrated_test.yaml](file:///home/andrii/Projects/labwired/examples/tests/stm32f103_integrated_test.yaml)) automates the simulation:
22+
The test script ([stm32f103_integrated_test.yaml](../../examples/tests/stm32f103_integrated_test.yaml)) automates the simulation:
2323

2424
```yaml
2525
schema_version: "1.0"

0 commit comments

Comments
 (0)