AI and agent access
Read the better-push documentation as clean Markdown without parsing the website.
The documentation site publishes Markdown generated from the same MDX files as the human-readable pages. Use these endpoints when an AI assistant, coding agent, or local indexing tool needs current better-push instructions.
| Need | Endpoint |
|---|---|
| Discover available pages | /llms.txt |
| Read all documentation at once | /llms-full.txt |
| Read one page | Append .md to its documentation URL |
For example, the Markdown version of the quickstart is
/docs/quickstart.md.
export BETTER_PUSH_DOCS_ORIGIN="https://docs.example.com"
curl "$BETTER_PUSH_DOCS_ORIGIN/llms.txt"
curl "$BETTER_PUSH_DOCS_ORIGIN/docs/quickstart.md"Clients that support HTTP content negotiation can request Markdown from the normal page URL:
curl -H "Accept: text/markdown" \
"$BETTER_PUSH_DOCS_ORIGIN/docs/quickstart"Set BETTER_PUSH_DOCS_ORIGIN to the current public documentation deployment.
The endpoints are served by that deployment itself, so moving from a beta URL
to a production domain does not require changing route code.
Use the page-specific endpoint for implementation work because it keeps the
context focused. Use llms-full.txt only when the task genuinely spans the full
library. Mermaid diagrams remain fenced Mermaid source in Markdown so agents can
understand the flow without extracting an SVG. Interactive component examples
are represented by their surrounding explanatory content.
These outputs are generated during the documentation build. Do not copy or sync them into a separate knowledge base unless your agent platform requires its own index.