docs: add btw.md and custom agents vignettes - #227
Merged
Merged
Conversation
…ined The Project or User Scope section said the user-level btw.md was only used when no project file was found. read_btw_file() always combines them: project client/tools win, options are merged, and both sets of instructions are included. Also mention CLAUDE.md in the lookup order and update the example's model and deprecated tool group names.
Replace the deprecated search and session aliases with cran and sessioninfo so new btw.md files don't trigger deprecation warnings.
The chunk demonstrating client selection in btw.md front matter was not marked eval = FALSE, so R CMD check launched the Shiny app and hung.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
vignette("btw-md")walks through configuring chats with abtw.mdfile: the YAML front matter (model, tools, options), project instructions, and how btw resolves and combines user-level and project files (includingAGENTS.md/CLAUDE.mdfallback).vignette("custom-agents")builds on it: writing agent files that describe one job (instructions, tools, model) and delegating tasks to subagents from abtw_app()/btw_client()chat.?use_btw_mdnow correctly documents how a user-levelbtw.mdis combined with a project's file (client/toolsfall back to user-level values,optionsare merged, both sets of instructions are included).use_btw_md()template now uses the currentcranandsessioninfotool group names instead of the deprecatedsearchandsessionaliases.VignetteBuilder: knitr,knitrin Suggests).Verification
Render the vignettes locally:
pkgdown::build_reference()isn't needed — just rundevtools::build_vignettes()or openvignettes/btw-md.Rmd/vignettes/custom-agents.Rmdin RStudio and knit. On the pkgdown site, both vignettes should appear under Articles.