tree: a6e5992d4c5eaf559017d2029e42c5d67b94e7d3 [path history] [tgz]
  1. doc_checker_test_data/
  2. src/
  3. BUILD.gn
  4. OWNERS
  5. README.md
tools/doc_checker/README.md

Doc checker

The present tool verifies the structure and content of documentation files.

What does it check?

Doc-checker checks the links and table of contents graph to enforce consistency and that all markdown pages in //docs are reachable. See more at https://fuchsia.dev/fuchsia-src/contribute/docs/doc-checker

Usage

To reproduce the check run as a static check for presubmits, Run:

fx doc-checker  --local-links-only

What if there is a bug?

Please file a bug. If it is blocking - let the OWNERS know and/or tq-devrel-eng@ and we'll work on it.

What if I have an idea of something to check?

Please file a bug. Or contribute here.