docs: add written procedures to Ollama and PR review guides#315
Open
rachaelrenk wants to merge 7 commits into
Open
docs: add written procedures to Ollama and PR review guides#315rachaelrenk wants to merge 7 commits into
rachaelrenk wants to merge 7 commits into
Conversation
Add thorough step-by-step written procedures to two high-traffic guides that previously had video content but thin written coverage. how-to-set-up-ollama.mdx: - Add Prerequisites section with VRAM/RAM requirements table - Add platform-specific install instructions (macOS, Linux, Windows) - Add proper model pull/run commands with real model names - Add model types glossary (updated formatting) - Add model performance comparison section with timing tips - Add OpenAI-compatible API integration with Python and Node.js examples - Add Modelfile customization section with worked example - Add Productivity tips and Next steps sections how-to-review-prs-like-a-senior-dev.mdx: - Rewrite opening with clearer framing (structured review vs. AI summaries) - Add Prerequisites section - Add 'Why structured review matters' conceptual section - Add step-by-step procedure: get diff, attach context, use prompt - Keep existing structured prompt template (preserved verbatim) - Add section-by-section explanation of the prompt output - Add Tips for iterating with example follow-up prompts - Add Next steps with related guides Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
![oz-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Overview
This PR expands two guides with written, step-by-step procedures for PR review and Ollama setup. The structure is useful, but the Ollama benchmarking section documents a command that will not produce the timing stats it tells readers to compare.
Concerns
- The
ollama runbenchmark example needs--verbosebefore it can show token timing stats. - The runnable GitHub CLI examples use angle-bracket placeholders instead of the docs style's ALL_CAPS placeholder values.
Verdict
Found: 1 critical, 0 important, 1 suggestions
Request changes
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
After cross-checking against official Ollama docs: - Fix macOS minimum version: macOS 12+ → macOS 14 Sonoma+ - Fix macOS install: replace non-official brew path with official curl script (same script as Linux); add DMG as manual alternative - Fix Windows install: add official PowerShell one-liner (irm https://ollama.com/install.ps1 | iex) alongside manual installer - Fix CLI command: ollama list → ollama ls (official canonical command) - Fix base URL: add trailing slash to http://localhost:11434/v1/ per official OpenAI compat docs - Fix REST API curl example: /api/generate → /api/chat with messages format - Remove undocumented preloading tip (ollama run <model> "") - Add --verbose flag for timing stats instead of claiming they print by default - Mention native ollama-python/ollama-js SDKs alongside OpenAI compat path - Fix gh pr view --web comment (was incorrectly 'copy the diff URL') Co-Authored-By: Oz <oz-agent@warp.dev>
Co-authored-by: oz-for-oss[bot] <277970191+oz-for-oss[bot]@users.noreply.github.com>
…-a-senior-dev.mdx Co-authored-by: oz-for-oss[bot] <277970191+oz-for-oss[bot]@users.noreply.github.com>
rachaelrenk
commented
Jul 10, 2026
| **Hardware requirements** | ||
|
|
||
| Before running large language models (LLMs) locally, confirm your hardware can handle them. | ||
| You'll need enough memory to load the model weights. The rule of thumb: roughly 1GB of memory per billion parameters. |
Contributor
Author
There was a problem hiding this comment.
Please avoid colloquialisms like "rule of thumb".
rachaelrenk
commented
Jul 10, 2026
- Remove 'rule of thumb' colloquialism; replace with 'as a general estimate' - Remove em dash from Apple Silicon sentence per suggestion (use period) - Consolidate benchmark example to single --verbose command so timing stats are actually visible (critical fix from oz-for-oss review) - Replace <PR-number> angle-bracket placeholders with PR_NUMBER (ALL_CAPS per docs style guide) in both the code block and inline reference Co-Authored-By: Oz <oz-agent@warp.dev>
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
1 participant
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
Add thorough step-by-step written procedures to two high-traffic guides that previously had video content but thin or missing written coverage.
Notion tracking item: https://app.notion.com/p/38143263616d81e58b9fc1522c554ac7
how-to-set-up-ollama.mdx(2,433 visitors / 3 months)The page previously had a video embed and narrative sections with no actual install commands or runnable code. Added:
ollama pull/ollama runcommands with real model names;ollama ls/ollama psreference--verboseflag for timing stats,ollama psfor memory usage- Compare model performance — non-interactive prompt mode,--verboseflag for timing stats,ollama psfor memory usage- **Comparnative Ollama SDKsModelfilewalkthrough with a worked example (system prompt + parameters)how-to-review-prs-like-a-senior-dev.mdx(225 visitors / 3 months)The page previously had The page previously had The page previously had The page previously had The page previously had The page previously had The pageed:
Generated with Oz
Co-Authored-By: Oz oz-agent@warp.dev