|
| 1 | +## Documentation Generation Plan |
| 2 | + |
| 3 | +> This README tracks the step‑by‑step plan (and progress) for writing AI‑facing documentation for the **Thirdweb JS SDK** that lives under `.ai-docs/sdk/ai-docs`. Every major task is represented by a checkbox so work can be paused and resumed at any time. |
| 4 | +
|
| 5 | +### Phase 1 — Preparation |
| 6 | + |
| 7 | +- [ ] 1. **Inventory public API surface** |
| 8 | + - crawl `packages/thirdweb/src` and record exported symbols from `exports/*` entrypoints |
| 9 | +- [ ] 2. **Design doc‑file layout** |
| 10 | + - decide filename conventions (`components/`, `hooks/`, `classes/`, `types/`, etc.) and cross‑linking strategy |
| 11 | +- [ ] 3. **Pick documentation template** |
| 12 | + - introduction |
| 13 | + - signature table (props / params / returns) |
| 14 | + - example‑in‑context snippet |
| 15 | + - related links |
| 16 | + |
| 17 | +### Phase 2 — Core Building‑Blocks |
| 18 | + |
| 19 | +- [ ] 4. **`ThirdwebClient` class** (core HTTP / RPC client) |
| 20 | +- [ ] 5. **`createThirdwebClient` helper & configuration schema** |
| 21 | +- [ ] 6. **`useActiveAccount` React hook** |
| 22 | +- [ ] 7. **Wallet connection React components (`ConnectButton`, etc.)** |
| 23 | +- [ ] 8. **Transaction helpers (`prepareContractCall`, `sendTransaction`, etc.)** |
| 24 | +- [ ] 9. **`Contract` abstraction & frequently‑used methods** |
| 25 | + |
| 26 | +### Phase 3 — Supporting Modules |
| 27 | + |
| 28 | +- [ ] 10. **Storage / File upload APIs** |
| 29 | +- [ ] 11. **Auth module (`login`, `logout`, `validateSession`)** |
| 30 | +- [ ] 12. **Gas & Pay utilities** |
| 31 | +- [ ] 13. **Chain / Network constants & helpers** |
| 32 | +- [ ] 14. **Analytics / Insight utilities** |
| 33 | + |
| 34 | +### Phase 4 — Reference & Indexes |
| 35 | + |
| 36 | +- [ ] 15. **Generate master index file listing all doc pages** |
| 37 | +- [ ] 16. **Write contribution guidelines for keeping docs up‑to‑date** |
| 38 | +- [ ] 17. **Quality pass: lint markdown, verify code samples compile** |
| 39 | + |
| 40 | +--- |
| 41 | + |
| 42 | +Each completed task should result in one or more Markdown files added under `.ai-docs/sdk/ai-docs/` following the agreed‑upon template. Keep this checklist updated as progress is made. |
0 commit comments