Skip to content

Kneo Agent SDK

Publication-grade artifacts

Publication-grade artifacts¶

Documents intended for distribution to end users as-is. The full project index lives at ../README.md.

Contents¶

kneo_agent_api_reference.html / .pdf — the full public-API reference manual. Self-contained, dark-themed HTML with sidebar navigation; the PDF is the same content rendered for offline / print consumption.

Both files are hand-maintained rather than generated from the .md sources under ../dev/. They are tracked in git so consumers can read the offline copies without rebuilding.

Regeneration of the PDF from the HTML is wired through ../script/render_pdf_with_header_footer.mjs:

TS=$(date '+%Y-%m-%d %H:%M:%S %Z')
node docs/script/render_pdf_with_header_footer.mjs \
  "$(pwd)/docs/pub/kneo_agent_api_reference.html" \
  "$(pwd)/docs/pub/kneo_agent_api_reference.pdf" \
  "Kneo Agent — API Reference Manual" \
  "$TS"

The per-release recipe in ../dev/HowTo-pub-PyPI.md calls out regenerating the reference manual during pre-flight; if you only edited the HTML in this directory, the PDF needs to follow.

Files¶