Skip to content

docs: clarify Ollama install steps and add system requirements#53

Open
mfafore22 wants to merge 2 commits into
mainfrom
docs/update-readme-prereqs
Open

docs: clarify Ollama install steps and add system requirements#53
mfafore22 wants to merge 2 commits into
mainfrom
docs/update-readme-prereqs

Conversation

@mfafore22

@mfafore22 mfafore22 commented Jun 29, 2026

Copy link
Copy Markdown
Member

Addresses items 1 and 2 from the README verification issue.

Changes:

  • Update Ollama URL from ollama.ai to ollama.com
  • Add System requirements section with minimum RAM and lighter model suggestion
  • Add explicit Ollama install command for Linux
  • Link to ollama.com/download for macOS and Windows
  • Add note about ensuring the Ollama daemon is running before pulling models
  • Mention llama3.2:1b as an alternative for low-memory environments

Summary by CodeRabbit

  • Documentation
    • Expanded setup instructions with clearer system requirements, including memory guidance and a lighter model option.
    • Added platform-specific Ollama installation steps and a note to ensure the Ollama service is running before downloading models.
    • Improved the quick start flow by combining setup, cloning, and model download steps into one place.
    • Reorganized the guide to make installation and setup easier to follow.

@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@mfafore22, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 38 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 1e3405b8-6f15-4294-aed1-5a7cb4c90dd5

📥 Commits

Reviewing files that changed from the base of the PR and between 34b8dfa and 1f1fb19.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

README.md was restructured to consolidate setup instructions. A new "System requirements" subsection and "Installing Ollama" subsection (with OS-specific commands and a daemon reminder) were added under "Installation and Setup." The "Quick Start" was expanded to include model pulling steps. The previously standalone "Quick Start" under "Usage" was removed.

Changes

README Documentation Update

Layer / File(s) Summary
Full README rewrite
README.md
Adds system requirements and Ollama installation subsections; expands Quick Start with model pull commands including a low-memory alternative; removes duplicate standalone Quick Start from Usage; retains Features, Target Use Cases, CLI Usage, Available Sites, Contributing, License, and Contributors sections with layout adjustments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hopped in, quill in paw,
"The docs were sparse — I spotted the flaw!"
Now Ollama's installed with OS-smart care,
Quick Start expanded beyond all compare,
The README blooms fresh in the spring morning air! 🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the README docs update about Ollama installation steps and system requirements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/update-readme-prereqs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mfafore22

Copy link
Copy Markdown
Member Author

Opened PR #53 to address items 1 and 2 (Ollama install steps and system requirements).

The remaining items (undocumented CLI commands, expected output examples) will follow in a separate PR.

@sonarqubecloud

Copy link
Copy Markdown

@github-actions

Copy link
Copy Markdown

👋 Hi @mfafore22, thanks for the pull request! Before this can be merged, please address: Lint (prek).

Details and local reproduction commands are below, with links to the relevant CONTRIBUTING.md section for each.

CI Failures

❌ prek
check yaml...............................................................Passed
fix end of files.........................................................Passed
trim trailing whitespace.................................................Passed
check for added large files..............................................Passed
check for case conflicts.................................................Passed
check json...............................................................Passed
check toml...............................................................Passed
check for merge conflicts................................................Passed
pyupgrade................................................................Passed
Add trailing commas......................................................Passed
ruff (legacy alias)......................................................Passed
ruff format..............................................................Passed
keep-sorted..............................................................Passed
Lint GitHub Actions workflows............................................Passed
Lint Markdown............................................................Failed
- hook id: markdownlint-cli2
- exit code: 1
- files were modified by this hook

  markdownlint-cli2 v0.22.1 (markdownlint v0.40.0)
  Finding: .claude/skills/create-issue/SKILL.md tapio/prompts/system_prompt.md CONTRIBUTING.md .github/copilot-instructions.md !tapio/prompts/** !.venv/**
  Linting: 3 file(s)
  Summary: 0 error(s)
  markdownlint-cli2 v0.22.1 (markdownlint v0.40.0)
  Finding: docs/ADRs/README.md tapio/prompts/user_query.md docs/ADRs/0001-cloudflare-crawler.md CLAUDE.md !tapio/prompts/** !.venv/**
  Linting: 3 file(s)
  Summary: 0 error(s)
  markdownlint-cli2 v0.22.1 (markdownlint v0.40.0)
  Finding: README.md .claude/skills/backlog/SKILL.md docs/ADRs/_template.md !tapio/prompts/** !.venv/**
  Linting: 3 file(s)
  Summary: 14 error(s)
  README.md:158 error MD024/no-duplicate-heading Multiple headings with the same content [Context: "Tapio"]
  README.md:158 error MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "Tapio"]
  README.md:165 error MD024/no-duplicate-heading Multiple headings with the same content [Context: "Features"]
  README.md:175 error MD024/no-duplicate-heading Multiple headings with the same content [Context: "Target Use Cases"]
  README.md:189 error MD024/no-duplicate-heading Multiple headings with the same content [Context: "Installation and Setup"]
  README.md:191 error MD024/no-duplicate-heading Multiple headings with the same content [Context: "Prerequisites"]
  README.md:197 error MD024/no-duplicate-heading Multiple headings with the same content [Context: "Quick Start"]
  README.md:213 error MD024/no-duplicate-heading Multiple headings with the same content [Context: "Usage"]
  README.md:215 error MD024/no-duplicate-heading Multiple headings with the same content [Context: "CLI Overview"]
  README.md:226 error MD024/no-duplicate-heading Multiple headings with the same content [Context: "Quick Example"]
  README.md:244 error MD024/no-duplicate-heading Multiple headings with the same content [Context: "Available Sites"]
  README.md:260 error MD024/no-duplicate-heading Multiple headings with the same content [Context: "Contributing"]
  README.md:264 error MD024/no-duplicate-heading Multiple headings with the same content [Context: "License"]
  README.md:268 error MD024/no-duplicate-heading Multiple headings with the same content [Context: "Contributors ✨"]

Run uv run prek run --all-files locally to reproduce and fix. See Pre-commit Hooks (prek) in CONTRIBUTING.md.

Test Coverage Report

87% coverage (required: ≥80%)

Coverage meets the project threshold. 🎉

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.

1 participant