Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): New logo & Readme(s) revamp #79

Merged
merged 8 commits into from
Nov 7, 2024

Conversation

mateobelanger
Copy link
Member

@mateobelanger mateobelanger commented Oct 25, 2024

This pull request includes updates to configuration files and documentation improvements. The changes primarily focus on updating the README.md files for better clarity and adding new badges and examples.

For now the rig & playgrounds logos are added as files to the repo. If you agree with the style changes I'll move the files to the rig-site repo and switch to hyperlinks.

Documentation Updates:

  • README.md: Updated logo sources, added new badges, improved wording, and added new sections for getting started and integrations. [1] [2] [3]
  • rig-lancedb/README.md: Updated the introduction with logos and added usage instructions.

close https://github.com/0xPlaygrounds/KnowledgeBase/issues/30

@0xMochan
Copy link
Contributor

0xMochan commented Oct 28, 2024

image

interesting, i'm not sure about "By" not being aligned w/ "Playgrounds". Otherwise, it's very nice!

@mateobelanger
Copy link
Member Author

image interesting, i'm not sure about "By" not being aligned w/ "Playgrounds". Otherwise, it's very nice!

@0xMochan
Thanks for the feedback! Yeah bizarre quirk of svg because in my editor it's aligned. Will probably have to use png/jpeg.

@mateobelanger mateobelanger self-assigned this Nov 5, 2024
@mateobelanger mateobelanger changed the title docs(readme): test new logo coloration docs(readme): New logo & Readme(s) revamp Nov 5, 2024
@mateobelanger mateobelanger marked this pull request as ready for review November 5, 2024 17:34
Copy link
Contributor

@cvauclair cvauclair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work! But there are a few things to change. Also, the README example is outdated and should be:

use rig::{completion::Prompt, providers::openai};

#[tokio::main]
async fn main() {
    // Create OpenAI client and model
    // This requires the `OPENAI_API_KEY` environment variable to be set.
    let openai_client = openai::Client::from_env();

    let gpt4 = openai_client.agent("gpt-4").build();

    // Prompt the model and print its response
    let response = gpt4
        .prompt("Who are you?")
        .await
        .expect("Failed to prompt GPT-4");

    println!("GPT-4: {response}");
}

(change openai_client.model to openai_client.agent)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
rig-lancedb/README.md Outdated Show resolved Hide resolved
<a href="https://github.com/0xPlaygrounds/rig?tab=MIT-1-ov-file"><img src="https://img.shields.io/badge/license-MIT-00bfff.svg?color=red" /></a>
<a href="https://twitter.com/Playgrounds0x"><img src="https://img.shields.io/twitter/follow/Playgrounds0x"></a>
<a href="https://docs.rs/rig-core/latest/rig/"><img src="https://img.shields.io/badge/📖documentation-docs.rs-dca282.svg" /></a>
<br>
</p>
&nbsp;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image This seems wrong / duplicates.., might want to clean this up

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine on my browser 🤔
image

@mateobelanger mateobelanger merged commit cf57a8c into main Nov 7, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants