Skip to content

init

Scaffolds a bare docs/ tree with the structure doctor expects.

CLASS DESCRIPTION
InitReport

Result of init: which docs/ items were created vs already present.

FUNCTION DESCRIPTION
run_init

Scaffold docs_dir’s structure. Existing items are left untouched and reported as such.

Classes

InitReport dataclass

InitReport(created: list[str] = list(), already_present: list[str] = list())

Result of init: which docs/ items were created vs already present.

Functions:

run_init

run_init(docs_dir: Path) -> InitReport

Scaffold docs_dir’s structure. Existing items are left untouched and reported as such.