pxt-checkdocs Manual Page

Validates the documentation looking for broken links or broken code snippets.

pxt checkdocs [--re foo]

Description

This commands scans the documentation and perfoms various validation steps:

  • checking for broken links,
  • compiling and decompiling code samples

This command is also automatically run from a cloud build and will fail the build if any issue arises.

Flags

re path (optional)

Regex filter to select files to be scanned for snippets

Other

Add a .ignorelargefiles file in a folder to disable large file checks under this folder.

See Also

pxt tool