Skip to content

docs: add Ollama (local open-source models) support guide#16

Merged
yennanliu merged 2 commits into
mainfrom
docs/ollama-support
Jul 18, 2026
Merged

docs: add Ollama (local open-source models) support guide#16
yennanliu merged 2 commits into
mainfrom
docs/ollama-support

Conversation

@yennanliu

Copy link
Copy Markdown
Owner

Document how to run the InvestSkill frameworks on local models via Ollama — no API key, offline-capable. Adds README-ollama.md covering the paste path and the tool-capable-client path for live data, plus a platform row in README.md and an Ollama column/section in PLATFORM-COMPATIBILITY.md. Docs-only; all framework counts unchanged.

Description

Please include a summary of the changes and which issue is fixed (if applicable).

Fixes # (issue)

Type of Change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • New skill added
  • Plugin update

Changes Made

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own changes
  • JSON files are valid (marketplace.json, plugin.json)
  • SKILL.md files have proper frontmatter with description
  • Version numbers are consistent across files (if applicable)
  • I have updated the CHANGELOG.md with my changes
  • Documentation has been updated (README.md, skill descriptions)
  • All skills have been tested and work as expected

Testing

Please describe how you tested your changes:

Additional Notes

Add any other context about the pull request here.


For New Skills:

  • Skill has a clear, descriptive name
  • SKILL.md includes proper frontmatter with description
  • Skill provides actionable, professional-grade analysis
  • Skill aligns with the InvestSkill marketplace theme

For Plugin Updates:

  • plugin.json version has been bumped
  • marketplace.json has been updated with new version
  • CHANGELOG.md includes the changes

Document how to run the InvestSkill frameworks on local models via
Ollama — no API key, offline-capable. Adds README-ollama.md covering
the paste path and the tool-capable-client path for live data, plus a
platform row in README.md and an Ollama column/section in
PLATFORM-COMPATIBILITY.md. Docs-only; all framework counts unchanged.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added documentation Improvements or additions to documentation size/small labels Jul 18, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces support for running InvestSkill frameworks locally using Ollama, adding a dedicated README-ollama.md guide and updating README.md and PLATFORM-COMPATIBILITY.md to reflect this new platform. The review feedback highlights two inconsistencies in the updated PLATFORM-COMPATIBILITY.md table: the analysis skills count should be updated from 18 to 25, and the offline support status for Claude Code, Cursor, and Gemini CLI should be corrected to show they do not support offline mode, aligning with their detailed sections.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread PLATFORM-COMPATIBILITY.md Outdated
| **Works Offline** | ✅ | ✅ | ✅ | ❌ | ✅ |
| Feature | Claude Code | Cursor | Gemini CLI | Copilot | Universal | Ollama |
|---------|:-----------:|:------:|:----------:|:-------:|:---------:|:------:|
| **18 Analysis Skills** | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The row header states 18 Analysis Skills, but the repository has been updated to support 25 skills (as advertised in README.md and README-ollama.md). Please update this row to reflect the correct count of 25 skills.

Suggested change
| **18 Analysis Skills** |||||||
| **25 Analysis Skills** |||||||

Comment thread PLATFORM-COMPATIBILITY.md Outdated
| **File References** | ➖ | ✅ | ✅ | ➖ | ➖ | ➖ |
| **Copy/Paste Ready** | ➖ | ➖ | ➖ | ➖ | ✅ | ✅ |
| **Real-Time Updates** | ✅ | ✅ | ✅ | ✅ | ⏰ | ⏰ |
| **Works Offline** | ✅ | ✅ | ✅ | ❌ | ✅ | ✅ |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There is an inconsistency in the Works Offline row. The table marks Claude Code, Cursor, and Gemini CLI as (fully supported), but their detailed sections below explicitly state that offline mode is not supported (e.g., line 57: ❌ Offline mode (requires marketplace check), line 112: ❌ Offline mode (Cursor requires internet), and line 175: ❌ Offline mode (requires Gemini API)). Please update the table row to accurately reflect offline support for these platforms.

Suggested change
| **Works Offline** | | | ||||
| **Works Offline** | | | ||||

Address code-review feedback on the Quick Comparison table:
- "18 Analysis Skills" -> "25" to match the advertised framework count
- "Works Offline" now ❌ for Claude Code / Cursor / Gemini CLI, matching
  their own detail sections (they require a cloud API); only Universal
  and Ollama run fully offline

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@yennanliu
yennanliu merged commit 6d0b28d into main Jul 18, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant