Skip to contents

Canonical build entrypoint for rllmdoc. Resolves the project once, runs any required pre-build steps once, then generates both files.

Usage

build_llms_docs(proj_root = ".", force = FALSE)

Arguments

proj_root

Path to the project root. Defaults to the current directory.

force

When TRUE, clears and rebuilds site output before generation.

Value

Invisibly returns a named list with llms_txt and llms_full_txt paths plus the mirrored _llms directory path.

Details

This is the public build step for a correctly configured project. It does not perform project setup. It ensures the native companion markdown exists when needed, replaces any native llms.txt in the site output with the final curated, spec-valid llms.txt and llms-full.txt, and mirrors the llms-only output into a root-level _llms/ directory for local agent consumption.

Examples

if (FALSE) { # \dontrun{
result <- build_llms_docs()
result$llms_txt
result$llms_full_txt
} # }