Skip to content

Commit 3dc9b21

Browse files
author
baton-admin[bot]
committed
chore: update baton-admin doc files
1 parent bcbaa19 commit 3dc9b21

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

.claude/skills/connector/fix-ci-checks.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,29 @@ git add baton_capabilities.json config_schema.json docs/connector.mdx
132132

133133
## Verify workflow failures
134134

135+
### MDX documentation validation failures
136+
137+
**When**: The `Verify / docs` job fails with "MDX compilation failed."
138+
139+
**Cause**: `docs/connector.mdx` has syntax that the MDX compiler can't parse. The verify workflow compiles the MDX using the same compiler the registry uses to generate documentation HTML.
140+
141+
**Common causes and fixes**:
142+
143+
| Error | Cause | Fix |
144+
|-|-|-|
145+
| `Expected component 'X' to be defined` | Unknown component tag | Use only: `Tip`, `Warning`, `Note`, `Info`, `Icon`, `Steps`, `Step`, `Tabs`, `Tab`, `Frame`, `Card` |
146+
| `Expected the closing tag after the end of 'listItem'` | Closing tag (e.g. `</Warning>`) indented inside a list item | Move the closing tag to column 0 (no indentation) |
147+
| `Unexpected closing tag` | Mismatched open/close tags | Check that every `<Tip>` has `</Tip>`, etc. |
148+
| `Could not parse expression` | Bare curly braces `{` `}` in text | Escape as `\{` `\}` or wrap in backticks |
149+
150+
**Fix**: Run the MDX compiler locally to see the full error:
151+
152+
```bash
153+
npx --yes @mdx-js/mdx < docs/connector.mdx
154+
```
155+
156+
**Key rule for MDX**: Block-level custom component tags (`<Tip>`, `</Warning>`, etc.) must start at column 0 — no leading whitespace. Indented closing tags are the most common cause of failures.
157+
135158
### Lint failures
136159

137160
**When**: The `Verify / lint` job fails.

0 commit comments

Comments
 (0)