Skip to content

Commit 346f4ff

Browse files
committed
docs: clarify tsx invocation requirement
1 parent 34d49f3 commit 346f4ff

2 files changed

Lines changed: 5 additions & 4 deletions

File tree

toolkit-docs-generator/CURATION.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -241,9 +241,8 @@ toolkit with its message, and exits non-zero on failure. It runs the same
241241
compiler generation uses, so a pass means kinds, frontmatter, and MDX are all
242242
valid. It cannot check `tool:` targets.
243243

244-
Invoke `tsx` by path, not through `pnpm exec`, which resets the working
245-
directory to the repo root and breaks the relative path. `pnpm dlx tsx` also
246-
works.
244+
Invoke `tsx` by path because `toolkit-docs-generator` has no package for
245+
`pnpm exec`.
247246

248247
Seeing a chunk on a page needs generated JSON. Either wait for the automated
249248
generation PR, or generate that one toolkit with Engine credentials and run

toolkit-docs-generator/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,9 @@ pnpm dlx tsx src/cli/index.ts generate \
129129

130130
## Local usage
131131

132-
Run these commands from the `toolkit-docs-generator` directory.
132+
Run these commands from the `toolkit-docs-generator` directory. Invoke `tsx` by
133+
path because this directory has no package for `pnpm exec`; the sidebar sync
134+
command below runs from the repo root instead.
133135

134136
Generate a single toolkit:
135137

0 commit comments

Comments
 (0)