Skip to contents

rllmdoc Artalytics logo

Overview

rllmdoc generates spec-compliant llms.txt and llms-full.txt files for Quarto website and book projects and R package documentation sites built with pkgdown. It uses native Quarto/pkgdown markdown companions as source material, but writes its own final llms.txt so the tracked artifact is curated and spec-valid. It also mirrors llms-only artifacts into a root _llms/ directory for local agent consumption.

Installation 

pak::pak("artalytics/rllmdoc")

Quick Start

For most projects, the workflow is:

rllmdoc::use_llm_docs()
rllmdoc::llms_document()

If rendering already happens elsewhere, generate the final artifacts from existing output with:

rllmdoc::build_llms_docs(".")

build_llms_docs() assumes the project is already configured for rllmdoc, but it can still ensure the native companion markdown exists before writing the final site-local llms.txt/llms-full.txt and mirroring them into _llms/.

Documentation Map

  • Humans start here: README.md
  • Agents start in AGENTS.md
  • Workflow and usage details: vignettes/rllmdoc.qmd
  • Spec guarantees and failure modes: vignettes/spec-contract.qmd
  • Release history: NEWS.md
  • Forward-looking roadmap: The plan next-phase-pipeline in the $AGENTS_HOME plans directory
  • Research and discussion context: DISCUSS.md

Development 

devtools::document()
devtools::test()
devtools::check()
pkgdown::build_site()

When rebuilding the published docs site, run rllmdoc::build_llms_docs(".") after pkgdown::build_site() so the tracked docs/llms.txt is the rllmdoc-generated, spec-valid file rather than pkgdown’s native output, and so the root _llms/ mirror stays in sync.

Support