Skip to content

Commit af0441d

Browse files
committed
add missing update documentation step for chip series porting instructions
1 parent da6035b commit af0441d

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

‎docs/porting-series.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,12 @@ strategy:
196196
chip: [ch32v006x8x6, ch32v007x8x6]
197197
```
198198
199+
## Step 7: Update documentation
200+
201+
- Add the new series to the [flash modes](flash-modes.md) table with its system/user flash sizes.
202+
- Add an entry under [examples](examples.md) describing the new series directory.
203+
- If the series introduces new boot-mode selection behavior, transports, or other concepts not covered by existing docs, add or update the relevant handbook pages.
204+
199205
## Checklist
200206
201207
- [ ] Feature flags added to `ch32/Cargo.toml` for each variant
@@ -206,5 +212,5 @@ strategy:
206212
- [ ] Example `build.rs` lists all variants in `CHIPS` array
207213
- [ ] Builds for both `system-flash` and `user-flash` modes
208214
- [ ] CI job added for the new series in `.github/workflows/ci.yml`
209-
- [ ] Handbook updated if the port adds new concepts or configuration
215+
- [ ] Documentation updated (flash modes table, examples page, any new concepts)
210216
- [ ] Tested on hardware

0 commit comments

Comments
 (0)