From 90113670f5b1ee8727647f5bbf4724fa8f69c87c Mon Sep 17 00:00:00 2001 From: sapphi-red <49056869+sapphi-red@users.noreply.github.com> Date: Sun, 25 May 2025 14:22:22 +0900 Subject: [PATCH] Update README to use correct generation command for tsconfig-references --- README.md | 4 ++-- packages/glossary/README.md | 4 ++-- packages/tsconfig-reference/README.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index afd790324ad9..864109b6dd28 100644 --- a/README.md +++ b/README.md @@ -102,9 +102,9 @@ A set of tools and scripts for generating a comprehensive API reference for the ```sh # Generate JSON from the typescript cli -pnpm run --filter=tsconfig-reference generate-json +pnpm run --filter=tsconfig-reference generate:json # Jams them all into a single file -pnpm run --filter=tsconfig-reference generate-markdown +pnpm run --filter=tsconfig-reference generate:md ``` Validate the docs: diff --git a/packages/glossary/README.md b/packages/glossary/README.md index 6d15bdbfe55f..8b06f5c44d76 100644 --- a/packages/glossary/README.md +++ b/packages/glossary/README.md @@ -36,9 +36,9 @@ The TSConfig reference is created by a two step process: You can run these commands from the root of the repo: ```sh -pnpm run --filter=tsconfig-reference generate-json +pnpm run --filter=tsconfig-reference generate:json -pnpm run --filter=tsconfig-reference generate-markdown +pnpm run --filter=tsconfig-reference generate:md ``` You can validate any codeblocks which use twoslash via the script: diff --git a/packages/tsconfig-reference/README.md b/packages/tsconfig-reference/README.md index 6d15bdbfe55f..8b06f5c44d76 100644 --- a/packages/tsconfig-reference/README.md +++ b/packages/tsconfig-reference/README.md @@ -36,9 +36,9 @@ The TSConfig reference is created by a two step process: You can run these commands from the root of the repo: ```sh -pnpm run --filter=tsconfig-reference generate-json +pnpm run --filter=tsconfig-reference generate:json -pnpm run --filter=tsconfig-reference generate-markdown +pnpm run --filter=tsconfig-reference generate:md ``` You can validate any codeblocks which use twoslash via the script: