<!-- generated by epythet -->

# For AI agents

`hfdol` ships artifacts for coding agents alongside its code. This page lists
them, says where each lives in the repository, and points at the
machine-readable copies of this documentation.

## Skills

Skills are folders holding a `SKILL.md` (the [Agent Skills](https://agentskills.io) format): a description that tells an agent when to use it and a body with the procedure. Install one into your agent with `gh skill` (any host: `--agent claude-code`, `copilot`, `cursor`, `codex`, `gemini`), or use the copy bundled in the wheel.

### `hf-space-deploy`

Deploy a Python webapp (FastAPI backend + frontend) to a Hugging Face Space using the Docker SDK. Use when the user wants to “publish to HF”, “put this on Hugging Face Spaces”, “ship a Space”, “host the app on HF”, “make a Space for X”, or “deploy a Gradio/FastAPI/Streamlit app to Hugging Face.” Also triggers on rebuild/refresh requests for an existing Space, factory reboots, swapping out a Space’s PyPI version pin, or fixing build failures. The skill assumes the package is on PyPI; if it isn’t yet, suggest publishing first (or ship source via the Dockerfile).

Source: [`.claude/skills/hf-space-deploy`](https://github.com/thorwhalen/hfdol/tree/HEAD/.claude/skills/hf-space-deploy).

## Machine-readable documentation

This site publishes the same documentation in forms that fit an agent’s context window:

- [`llms.txt`](https://thorwhalen.github.io/hfdol/llms.txt): an index of every page with a one-line description ([llms.txt](https://llmstxt.org) format)
- [`hfdol.md`](https://thorwhalen.github.io/hfdol/hfdol.md): the whole documentation as one Markdown file
- `<page>.html.md`: a rendered Markdown twin of every page, advertised from each page’s `<head>` with `<link rel="alternate" type="text/markdown">`
- [`objects.inv`](https://thorwhalen.github.io/hfdol/objects.inv): the Sphinx inventory: a symbol-to-URL index (`sphobjinv convert plain objects.inv -`)
