Document automated agent-friendly format generation in README

Add comprehensive documentation for make formats and all generated files:
- blog.json (JSON Blog format at root)
- feeds/all.json (JSON Feed v1.1)
- llms.txt (AI agent onboarding)
- index.md (Markdown versions)
- index.txt (plain text versions)

Documents purpose, usage, requirements, and individual make targets
(rst2md, jsonfeed, jsonblog, plaintext, llms).
This commit is contained in:
russell@unturf.com 2026-01-19 14:49:28 -05:00
parent 7c91647a55
commit 9ba114df33

View file

@ -41,12 +41,52 @@ This builds the site and serves it at http://localhost:8000
.. code-block:: bash .. code-block:: bash
make venv # Setup virtual environment make venv # Setup virtual environment
make html # Build the site make html # Build the site
make clean # Remove output directory make clean # Remove output directory
make serve # Serve site at localhost:8000 make serve # Serve site at localhost:8000
make devserver # Serve with auto-reload make devserver # Serve with auto-reload
make resume # Generate PDF resume make resume # Generate PDF resume
make formats # Generate all agent-friendly formats
agent-friendly formats
===============================
The blog automatically generates multiple formats optimized for AI agents & LLM consumption:
**Automated format generation (run via ``make formats``):**
.. code-block:: bash
make rst2md # Convert all RST to Markdown (index.md)
make plaintext # Generate plain text versions (index.txt)
make jsonfeed # Generate JSON Feed v1.1 (/feeds/all.json)
make jsonblog # Generate JSON Blog format (/blog.json)
make llms # Generate llms.txt for AI agent onboarding
make formats # Run all of the above
**Generated files:**
- ``/blog.json`` - Entire blog in single JSON file (jsonblog.dev format)
- ``/feeds/all.json`` - JSON Feed v1.1 alternative to Atom/RSS
- ``/llms.txt`` - AI agent onboarding documentation with API info
- ``/*/index.md`` - GitHub-flavored Markdown for every post
- ``/*/index.txt`` - Plain text (no markup) for direct LLM ingestion
**Purpose:**
These formats enable AI agents, LLMs, & automated systems to:
- Ingest entire blog content in one request (blog.json)
- Subscribe to updates via JSON instead of XML (feeds/all.json)
- Discover blog structure & available formats (llms.txt)
- Read posts without HTML parsing (index.txt, index.md)
All formats are automatically generated during CI/CD builds & kept in sync with the HTML content.
**Requirements:**
- ``pandoc`` - Needed for RST to Markdown conversion (``make rst2md``)
production release process production release process
=============================== ===============================