chore: update README.md #24
Merged
Conversation
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
joshsny
approved these changes
May 6, 2025
Collaborator
joshsny
left a comment
joshsny
left a comment
There was a problem hiding this comment.
Really nice - left a couple small things as take it or leave it comments :)
README.md
Outdated
|
|
||
| ## Analytics | ||
|
|
||
| Did you know you can capture PostHog analytics even for ancillary products like a command line tool? `src/utils/analytics.ts` is a great example of how to do it. |
Collaborator
There was a problem hiding this comment.
ancillary is too complex a word for my brain to handle 😂
README.md
Outdated
|
|
||
| `src/lib/prompts.ts` demonstrates how to wrap a deterministic fence around a chaotic process. Every wizard session gets the same prompt, tailored to the specific files in the project. | ||
|
|
||
| These prompts are channeled using `src/utils/query.ts` to an LLM interface we host. This gives us more control: we can be certain of the model version and provider which interpret the prompts and modifies the files. This way, we can find the right tools for the job and again, apply them consistently. |
Collaborator
There was a problem hiding this comment.
The main goal of routing through the query endpoint is so that we pay on behalf of the user - it's very cheap and not needing them to paste in an api key is advantageous for creating a good flow. might be worth mentioning here!
daniloc
added a commit
that referenced
this pull request
Oct 27, 2025
* Update README.md * tweak * Update README.md * Update README.md with blog link * Copy tweaks * Copy tweaks
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.
Adding to our endless PR dependency chain, this one awaits our envoy blog post.
This pull adds some documentation to the readme to help developers get their bearings in the project. We now highlight the especially interesting code they'll want to understand to use it themselves.