Skip to main content

guildgate-writing-check

Writing check finds technical residue and unfinished template fields that should not be published. It does not decide whether prose is correct, well written, or authored by a particular person.

Help​

npx guildgate-writing-check --help
Usage: guildgate-writing-check [options]

Checks documentation files in the current project directory.

Options:
  --root <path>  Check another project directory.
  -h, --help     Show this help message.

Running the check​

npx guildgate-writing-check

Another project root:

npx guildgate-writing-check --root ./docs-site

The command returns a non-zero exit code when a check fails.

Issue classes it finds​

  • unfinished or temporary template fields
  • broken citation markers
  • temporary identifiers from a tool session
  • file-upload placeholders
  • writing-block markers that do not belong in published content
  • large TODO fields left during copying

This CLI page may name some markers to explain them; their presence in normal documentation is treated as an error.

Issues it does not find​

The command does not replace:

  • verifying API names against source code
  • typechecking example code
  • opening and reviewing source links
  • evaluating translation equivalence
  • security or legal review

CI​

package.json
{
  "scripts": {
    "docs:check": "guildgate-writing-check --root ."
  }
}
npm run docs:check

Run it before the Docusaurus build. Fix the file and marker type reported by the command instead of adding a broad ignore that hides the issue.

Last updated on