Skip to content

Commit ebc0fa7

Browse files
committed
Workspace docs: Clean up agent instructions (modules/flash)
Simplify root and module markdown instructions, add missing module AGENTS files, and move reusable datasheet authoring guidance into a dedicated skill. This keeps workspace guidance shorter, Czech-first for internal modules, and easier for agents to route into the right source of truth.
1 parent f619551 commit ebc0fa7

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# AGENTS.md — `modules/flash`
2+
3+
Pravidla pro TypeScript fork/vrstvu `esptool-js` a web flashing flow pro ESP
4+
controllery.
5+
6+
## Role modulu
7+
8+
- Modul vlastní Web Serial flashing knihovnu nad `esptool-js` a příklady pro
9+
firmware flashing.
10+
- Veřejná knihovní hranice je `src/index.ts` a build výstupy `lib/index.js`,
11+
`lib/index.d.ts` a `bundle.js`.
12+
- Spectoda Studio integrace, firmware hosting a produkční release flow patří
13+
mimo tenhle public/library povrch.
14+
15+
## Nejdřív otevři
16+
17+
- `README.md`
18+
- `package.json`
19+
- `CHANGELOG.md`
20+
- `src/index.ts`
21+
- `src/webserial.ts`
22+
- `src/esploader.ts`
23+
- relevantní example podklady, pokud řešíš browser flow
24+
25+
## Pravidla práce
26+
27+
- Používej npm. `package-lock.json` je lokální source of truth pro dependency
28+
pinning v tomhle modulu.
29+
- Při změně public API aktualizuj exporty v `src/index.ts` a ověř generované
30+
typy přes build.
31+
- `npm test` zatím není reálný test suite; nepoužívej ho jako validační gate.
32+
- Flash, erase a reset operace jsou destruktivní pro připojený ESP controller.
33+
Nespouštěj je bez jasného targetu, firmware binárek a souhlasu.
34+
35+
## Ověření
36+
37+
- `npm install`
38+
- `npm run build`
39+
- `npm run lint`
40+
- Browser smoke přes Browser Use jen pro UI/example flow; reálné Web Serial
41+
flashing funguje jen v Chrome/Edge s fyzickým ESP zařízením a uživatelským
42+
výběrem portu.

0 commit comments

Comments
 (0)