gen-sdk-docs

Overview ¶

Command gen-sdk-docs copies the SDK example programs into the Markdown that shows them, so what the READMEs and the guide print is the file CI compiles and runs against a mesh. A Markdown file marks where a file goes with a path relative to the repository root:

<!-- embed: sdk/js/examples/call.ts -->
```ts
(replaced with the file)
```
<!-- /embed -->

Usage: gen-sdk-docs [-check] <markdown file or directory>...

Directories are walked for .md files. With -check nothing is written and the exit status is 1 when any file is stale; hack/verify-sdk-generated.sh runs it that way.