Docs/add grok build cli to readme#1919
Open
boredcity wants to merge 1 commit into
Open
Conversation
Author
|
Oops, started with main and brought some changes from there it seems? 👀 will just leave my stuff. upd: no actual changes done by mode but it cherry-picked my commit on top of dev branch; because who likes doing this stuff manually. |
5a39218 to
a3b83bc
Compare
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.
Who is submitting this PR? (required)
Human person through and through, wanted to make sure I get it right and test it :)
What problem are you trying to solve?
There was no documented way to use this with Grok Build CLI, I documented one.
What does this PR change?
Grok Build CLI section to README.md file + link to it in the same file
Is this change appropriate for the core library?
Yes, it's a readme change intended for user-facing surface
What alternatives did you consider?
Being sad and having worse docs. Decided to go with better docs :)
Does this PR contain multiple unrelated changes?
No
Existing PRs
Environment tested
Tested commands with version [stable]
New harness support (required if this PR adds a new harness)
Clean-session transcript for "Let's make a react todo list"
Evaluation
I added couple of lines in readme carefully testing them in terminal. 🤷♂️
Verified link worked with markdown previewer.
Rigor
rationalizations, "human partner" language) without extensive evals
showing the change is an improvement
Human review