Generate llms documentation for a project

The main orchestration entrypoint for rllmdoc. Resolves project metadata via as_project(), auto-configures if needed (e.g., enables llms-txt: true for Quarto), ensures native companion markdown exists, and generates spec-compliant llms.txt and llms-full.txt.

Usage

llms_document(proj_root = ".", render = TRUE, force = FALSE)

Arguments

proj_root

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

render

Whether to ensure native rendered output exists before building llms artifacts. Set to FALSE to reuse existing rendered companion markdown and rebuild only the final llms artifacts.

force

When TRUE, clears previously generated output and rebuilds from scratch. Defaults to FALSE.

Value

Invisibly returns a named list with llms_txt, llms_full_txt, and mirrored _llms directory paths.

Details

This is the setup-aware convenience entrypoint. It handles detection, project configuration when needed, native companion generation, and final llms artifact generation.

See also

Other unified: use_llm_docs()

Examples

if (FALSE) { # \dontrun{
llms_document()
llms_document(render = FALSE)
llms_document(force = TRUE)
} # }