mix ptc.gen_docs (PtcRunner v0.14.0)

Copy Markdown View Source

Generates documentation from priv/functions.exs (ordinary implemented functions), priv/function_audit.exs (Clojure parity triage notes), and priv/java_interop.exs (bounded Java surface and presentation metadata):

  1. docs/function-reference.md — all implemented functions grouped by section
  2. docs/conformance/index.md — namespace coverage dashboard
  3. docs/conformance/*-audit.md — Clojure and Java compatibility audits
  4. docs/java-interop.md — bounded Java interop reference
  5. priv/schemas/ptc-host-config.schema.json — host-installation JSON Schema
  6. priv/schemas/ptc-application-manifest.schema.json — manifest JSON Schema
  7. priv/schemas/ptc-command-envelope-v3.schema.json — command envelope JSON Schema
  8. priv/schemas/ptc-project-config.schema.json — project launch JSON Schema
  9. docs/kernel-limits-reference.md — Kernel run-limit meanings and metadata
  10. docs/prelude-reference.md — shipped PTC-Lisp component and export catalog
  11. the exit-status catalog inside docs/reference/cli.md
  12. the static-site guide pages under site/guides/ (via mix ptc.gen_site_guides)

Usage

mix ptc.gen_docs
mix ptc.gen_docs --check

--check verifies the checked-in files without rewriting them.