Skip to content

Commit 51fb961

Browse files
committed
docs: add documentation plan and template for SDK docs
1 parent a6436b7 commit 51fb961

File tree

2 files changed

+88
-0
lines changed

2 files changed

+88
-0
lines changed

.ai-docs/sdk/ai-docs/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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.

.ai-docs/sdk/ai-docs/_DOC_TEMPLATE.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# <!-- Title: Replace with symbol name -->
2+
3+
<!-- Optional front‑matter -->
4+
5+
## <!--
6+
7+
title: <Symbol Name>
8+
category: <component | hook | class | type | util>
9+
10+
---
11+
12+
-->
13+
14+
## Description
15+
16+
_A concise, one‑sentence description of the symbol's purpose followed by longer context as needed._
17+
18+
## Usage
19+
20+
```tsx
21+
// Installation (if different from SDK umbrella)
22+
// pnpm add @thirdweb-dev/react
23+
24+
import /* symbol */ "@thirdweb-dev/react";
25+
26+
function Example() {
27+
// ... replace with realistic usage
28+
}
29+
```
30+
31+
## Signature
32+
33+
| Name / Prop | Type | Description |
34+
| ------------- | ---- | ----------- |
35+
| _coming soon_ | | |
36+
37+
## Example
38+
39+
```tsx
40+
// A complete runnable snippet goes here
41+
```
42+
43+
## Related
44+
45+
- <!-- link to other docs within `.ai-docs/sdk/ai-docs` -->
46+
- <!-- external links if helpful -->

0 commit comments

Comments
 (0)