Rewrite README as a learning path for beginners#63
Conversation
The README was organized like a reference manual: examples directory listing, then installation, then usage, then config. A student reading top-to-bottom would hit code samples before knowing how to set up their API key. Restructure as a learning funnel: - Open with quick start (install, .env setup, first working code) - Lead with the "it's just an array of hashes" insight early - Move proxy/Prepend.me setup near the top since most students use it - Replace single-letter variables (a, b, c...) with `chat` - Simplify structured output (lead with simplest schema format) - Add context to code interpreter section - Consolidate advanced features into one section - Move examples directory listing to the end as reference Content is preserved; the change is sequencing and clarity.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c0cbff8815
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| require "ai-chat" | ||
|
|
||
| And then, at a command prompt: | ||
| chat = AI::Chat.new |
There was a problem hiding this comment.
.env before constructing AI::Chat
The Quick Start now instructs users to put credentials in a .env file, but this example only does require "ai-chat"; in a plain Ruby script that does not already load Dotenv (unlike the examples), AI::Chat.new will raise a KeyError because ENV is still unset. This makes the first-run path fail for beginners unless they manually export vars, so the snippet should also load .env (for example via require "dotenv/load") or avoid .env guidance here.
Useful? React with 👍 / 👎.
1 participant
Summary
.envsetup) -> "it's just hashes" insight -> features -> advanceda,b,c...) withchatthroughoutNo code changes. Content is preserved; the change is sequencing and information density.
Test plan