MCPcopy Create free account
hub / github.com/Serial-Studio/Serial-Studio / default_targets

Function default_targets

scripts/documentation-verify.py:661–682  ·  view source on GitHub ↗

The default scan set: every first-party Markdown file. Top-level docs (README, AGENTS, CODE_OF_CONDUCT, DISCOVER), the `doc/help` manual, the in-app AI docs and skills under `app/`, the bundled examples, and the translation README. Vendored `lib/` trees and `LICENSE.md` are NOT in the

(repo_root: Path)

Source from the content-addressed store, hash-verified

659
660
661def default_targets(repo_root: Path) -> list[Path]:
662 """The default scan set: every first-party Markdown file. Top-level docs
663 (README, AGENTS, CODE_OF_CONDUCT, DISCOVER), the `doc/help` manual, the
664 in-app AI docs and skills under `app/`, the bundled examples, and the
665 translation README. Vendored `lib/` trees and `LICENSE.md` are NOT in the
666 set; `iter_markdown_files` enforces that for any explicit target too."""
667 out: list[Path] = []
668
669 # Top-level docs. LICENSE.md is deliberately omitted: it is a verbatim
670 # legal text, not prose we author or rewrite.
671 for top in ("README.md", "AGENTS.md", "CODE_OF_CONDUCT.md", "DISCOVER.md"):
672 p = repo_root / top
673 if p.is_file():
674 out.append(p)
675
676 # First-party doc / example / app-resource trees.
677 for rel in ("doc/help", "examples", "app/rcc/ai", "app/translations"):
678 d = repo_root / rel
679 if d.is_dir():
680 out.append(d)
681
682 return out
683
684
685# Directory names that are never first-party prose: vendored third-party

Callers 1

mainFunction · 0.70

Calls 1

appendMethod · 0.45

Tested by

no test coverage detected