From f1f2d65c8754245525ac0040b827e87b5d99ff79 Mon Sep 17 00:00:00 2001 From: simonpcouch Date: Fri, 11 Oct 2024 11:03:41 -0500 Subject: [PATCH] forefront Getting Started vignette --- README.Rmd | 4 +--- README.md | 12 +++++------- _pkgdown.yml | 6 ++++-- 3 files changed, 10 insertions(+), 12 deletions(-) diff --git a/README.Rmd b/README.Rmd index 7ffe1fe..e6f498c 100644 --- a/README.Rmd +++ b/README.Rmd @@ -31,9 +31,7 @@ You can install pal like so: pak::pak("simonpcouch/pal") ``` -Then, ensure that you have an [`ANTHROPIC_API_KEY`](https://console.anthropic.com/) set in your `.Renviron`---see [usethis::edit_r_environ()](https://usethis.r-lib.org/reference/edit.html) for more information. If you'd like to use an LLM other than Anthropic's Claude 3.5 Sonnet—like OpenAI's ChatGPT—to power the pal, see [`?.pal_init()`](https://simonpcouch.github.io/pal/reference/pal.html) for information on how to set default metadata on that model. - - +Then, ensure that you have an [`ANTHROPIC_API_KEY`](https://console.anthropic.com/) environment variable set, and you're ready to go. If you'd like to use an LLM other than Anthropic's Claude 3.5 Sonnet—like OpenAI's ChatGPT—to power the pal, see the [Getting started with pal](https://simonpcouch.github.io/pal/articles/pal.html) vignette. ## Example diff --git a/README.md b/README.md index 17a18d5..ba2599a 100644 --- a/README.md +++ b/README.md @@ -27,13 +27,11 @@ pak::pak("simonpcouch/pal") ``` Then, ensure that you have an -[`ANTHROPIC_API_KEY`](https://console.anthropic.com/) set in your -`.Renviron`—see -[usethis::edit_r_environ()](https://usethis.r-lib.org/reference/edit.html) -for more information. If you’d like to use an LLM other than Anthropic’s -Claude 3.5 Sonnet—like OpenAI’s ChatGPT—to power the pal, see -[`? .pal_init()`](https://simonpcouch.github.io/pal/reference/pal.html) for -information on how to set default metadata on that model. +[`ANTHROPIC_API_KEY`](https://console.anthropic.com/) environment +variable set, and you’re ready to go. If you’d like to use an LLM other +than Anthropic’s Claude 3.5 Sonnet—like OpenAI’s ChatGPT—to power the +pal, see the [Getting started with +pal](https://simonpcouch.github.io/pal/articles/pal.html) vignette. ## Example diff --git a/_pkgdown.yml b/_pkgdown.yml index 9b831e6..75b6fda 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -5,8 +5,10 @@ template: reference: - title: "Using pal" desc: > - Users of pal will generally not need to call any functions from the - package directly. See the "Getting Started" vignette. + **Users of pal will generally not need to call any functions from the + package directly.** See the + ["Getting Started with pal"](https://simonpcouch.github.io/pal/articles/pal.html) + vignette to learn how to work with—and extend—pals. # TODO: add these vignettes - title: Pals for package development contents: