Set up LLM documentation workflows for a project

Configures the project for rllmdoc documentation pipelines. This is the public setup entrypoint that can orchestrate multiple setup routines over time.

Usage

use_llm_docs(proj_root = ".")

Arguments

proj_root

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

Value

Invisibly returns the detected project type ("quarto" or "rpkg").

Details

Currently supported setup:

• Quarto website projects: adds llms-txt: true to the Quarto config.

• Quarto book projects: no config changes required; rllmdoc generates companion markdown from source chapters.

• R packages: no setup changes required at this stage; rllmdoc reuses pkgdown companion markdown and replaces the final llms.txt at build time.

Safe to run multiple times.

See also

Other unified: llms_document()

Examples

if (FALSE) { # \dontrun{
use_llm_docs()
} # }