Skip to content

AGENTS.md

Latest commit

 

History

History
63 lines (40 loc) · 1.68 KB

AGENTS.md

File metadata and controls

63 lines (40 loc) · 1.68 KB
Raw

Printing Press Agent Notes

Purpose

pb33f/printing-press is the CLI wrapper around the Printing Press renderer. It is responsible for:

  • loading a local or remote OpenAPI source
  • choosing build and output modes
  • rendering HTML, JSON artifacts, and LLM output
  • optionally serving the generated docs locally for preview

Repo Boundaries

  • CLI and preview-server behavior live in pb33f/printing-press
  • Core rendering logic, generated templates, and docs UI live in pb33f/doctor

Most browser-rendered docs behavior lives in pb33f/doctor, not here.

Common Commands

Build the CLI:

go build -o ppress .

Run it:

./ppress ./openapi.yaml

Test it:

go test ./...

There is no wrapper-owned UI rebuild or template-generation step here. Those belong to pb33f/doctor.

Build Modes

  • Default build: portable HTML assets for offline or file:// usage
  • --publish: hosted/served HTML assets without starting a local server
  • --serve: hosted/served HTML assets and starts the local preview server
  • --disable-export: when combined with --serve, hides local archive export controls and disables the preview export endpoint

--serve is for local development only. It is not intended as a production server.

Static Hosting

For GitHub Pages, S3, Netlify, Cloudflare Pages, or similar static hosting, use:

./ppress --publish --output ./api-docs ./openapi.yaml

Generated Output

This repo writes generated documentation to an output directory such as ./api-docs. That output is generated content, not hand-maintained project source.

If a change touches rendering behavior in pb33f/doctor, run the relevant tests there as well.