docs: fix quickstart install command#89
Open
Parikalp-Bhardwaj wants to merge 1 commit into
Open
Conversation
Contributor
|
@Parikalp-Bhardwaj is attempting to deploy a commit to the arc_team Team on Vercel. A member of the Team first needs to authorize it. |
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
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
This PR updates the Rig quickstart documentation so the installation instructions match the imports used in the example.
The quickstart example imports from the public
rigcrate path, but the docs currently tell users to installrig-core. Installingrig-coredirectly would require usingrig_coreas the import path, so this can be confusing for new users following the quickstart.Changes
rig-coretoriganyhowbecause the example usesanyhow::Errordotenvyso users can loadOPENAI_API_KEYfrom a local.envfile during development#[tokio::main]dotenvy::dotenv().ok();before creating the OpenAI clientWhy
This makes the quickstart easier to copy, run, and understand for new users.
With the updated instructions, users install the same crate used by the example imports:
They can also create a local .env file like:
OPENAI_API_KEY=your-api-key
and the example will load it automatically with:
dotenvy::dotenv().ok();@gold-silver-copper
Related to #88