Skip to content

Commit d9c2b93

Browse files
authored
docs: refine includeBoardFiles documentation (#253)
1 parent 1f74715 commit d9c2b93

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/guides/tscircuit-essentials/tscircuit-config.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,4 +93,27 @@ Specifies paths or directory names that should be ignored when the dev server sy
9393

9494
**Note:** By default, the system already ignores `.git` directories, `node_modules`, and certain special files like `manual-edits.json`.
9595

96+
### includeBoardFiles
97+
98+
**Type:** `array of file paths or glob strings` (optional)
99+
100+
Defines which board source files `tsci build` evaluates automatically. Each entry can be a specific path or a glob that resolves to `.circuit.tsx` files. When omitted, tscircuit builds every board that matches the default pattern `['**/*.circuit.tsx']`.
101+
102+
**Use Cases:**
103+
104+
- **Build a subset of boards:** Focus CI or preview builds on a curated list of boards without reorganizing your project tree.
105+
106+
**Example:**
107+
108+
```json
109+
{
110+
"includeBoardFiles": [
111+
"boards/main-board.circuit.tsx",
112+
"modules/**/*.board.tsx"
113+
]
114+
}
115+
```
116+
117+
**Note:** Paths and globs are resolved relative to the project root, just like `mainEntrypoint`.
118+
96119

0 commit comments

Comments
 (0)