github-starred/ollama
2
0
Fork 0
mirror of https://github.com/ollama/ollama.git synced 2026-07-18 06:06:18 -05:00
Code Issues 16.9k Packages Projects Releases 122 Wiki Activity

[GH-ISSUE #9371] [Documentation] Include local copy of Docs/important instructional readmes within installer #6118

New Issue
Open
opened 2026-04-12 17:27:19 -05:00 by GiteaMirror · 2 comments
GiteaMirror commented 2026-04-12 17:27:19 -05:00
Owner
Copy Link

Originally created by @Ashton-Haviland on GitHub (Feb 26, 2025).
Original GitHub issue: https://github.com/ollama/ollama/issues/9371

Proposal:

Include local copies of files in docs, as well as primary README.md.

Reasoning:

As a low level user, I often have to consult documentation, and have found the inbuilt Ollama apps help section to be lacking at times. As such I believe the addition of the pertinent files in the docs folder as well as the primary README could be added through the installer, and a new ollama help command could be added, like ollama help documentation. This would also allow users who have previously set up ollama, but currently have no internet a way to refresh themselves on functionality. This suggestion was thought of to help facilitate Nielson's Usability Heuristic 10, Help and Documentation, as providing the documentation with access within the app would better help users to understand how to complete their tasks regardless of circumstances(lack of internet/personal note-keeping). This could also help to facilitate heuristic 9, "Help Users Recognize, Diagnose, and Recover from Errors". For example, when an incorrect model name is entered it only states "Error: pull model manifest: file does not exist", whereas with the inclusion of the documentation files, it can guide users to the list of models(which also includes the webpage link) within the README.md file, which would help users to diagnose/recover from errors.

Originally created by @Ashton-Haviland on GitHub (Feb 26, 2025). Original GitHub issue: https://github.com/ollama/ollama/issues/9371 ### **Proposal:** Include local copies of files in docs, as well as primary README.md. ### **Reasoning:** As a low level user, I often have to consult documentation, and have found the inbuilt Ollama apps help section to be lacking at times. As such I believe the addition of the pertinent files in the docs folder as well as the primary README could be added through the installer, and a new `ollama help` command could be added, like `ollama help documentation`. This would also allow users who have previously set up ollama, but currently have no internet a way to refresh themselves on functionality. This suggestion was thought of to help facilitate Nielson's Usability Heuristic 10, Help and Documentation, as providing the documentation with access within the app would better help users to understand how to complete their tasks regardless of circumstances(lack of internet/personal note-keeping). This could also help to facilitate heuristic 9, "Help Users Recognize, Diagnose, and Recover from Errors". For example, when an incorrect model name is entered it only states "Error: pull model manifest: file does not exist", whereas with the inclusion of the documentation files, it can guide users to the list of models(which also includes the webpage link) within the README.md file, which would help users to diagnose/recover from errors.
GiteaMirror added the documentation label 2026-04-12 17:27:19 -05:00
GiteaMirror commented 2026-04-12 17:27:20 -05:00
Author
Owner
Copy Link

@flywiththetide commented on GitHub (Mar 4, 2025):

This is a great suggestion! Having offline-accessible documentation would be helpful for users who don’t always have internet access.

Potential Implementation Approaches

  1. Bundle Documentation with the Installer

    • The README.md, key API references, and docs/ could be packaged into the Ollama installation folder.
    • Example paths for different OS environments:
      • Linux/macOS: /usr/share/ollama/docs/
      • Windows: C:\Program Files\Ollama\docs\

  2. Implement a CLI Command for Offline Help

    • A new command like ollama help docs could display documentation: 
      ollama help docs
    • This command could:
      • Open the local README.md
      • Display an indexed list of common topics
      • Redirect users to the latest online docs when available

  3. Improve Error Messages with Documentation Links

    • When a user enters an incorrect model name or API call, Ollama could suggest relevant sections of the docs: 
      Error: Model 'xyz' not found. 
See 'ollama help models' or check /usr/share/ollama/docs/models.md

Would you be interested in testing an early version of this feature if it gets implemented?

<!-- gh-comment-id:2696262314 --> @flywiththetide commented on GitHub (Mar 4, 2025): This is a great suggestion! Having **offline-accessible documentation** would be helpful for users who don’t always have internet access. ### **Potential Implementation Approaches** 1. **Bundle Documentation with the Installer** - The `README.md`, key API references, and `docs/` could be packaged into the Ollama installation folder. - Example paths for different OS environments: - **Linux/macOS:** `/usr/share/ollama/docs/` - **Windows:** `C:\Program Files\Ollama\docs\` 2. **Implement a CLI Command for Offline Help** - A new command like `ollama help docs` could display documentation: ```bash ollama help docs ``` - This command could: - Open the local `README.md` - Display an indexed list of common topics - Redirect users to the latest online docs when available 3. **Improve Error Messages with Documentation Links** - When a user enters an incorrect model name or API call, Ollama could suggest relevant sections of the docs: ```plaintext Error: Model 'xyz' not found. See 'ollama help models' or check /usr/share/ollama/docs/models.md ``` Would you be interested in testing an early version of this feature if it gets implemented?
GiteaMirror commented 2026-04-12 17:27:21 -05:00
Author
Owner
Copy Link

@Ashton-Haviland commented on GitHub (Mar 4, 2025):

Sure, always would love to help! Keep me posted and I'll try to get on it as quickly as I can once it's up.

<!-- gh-comment-id:2698459447 --> @Ashton-Haviland commented on GitHub (Mar 4, 2025): Sure, always would love to help! Keep me posted and I'll try to get on it as quickly as I can once it's up.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
amd
api
app
bug
build
cli
cloud
compatibility
context-length
create
docker
documentation
embeddings
feature request
feedback wanted
good first issue
gpt-oss
gpu
harmony
help wanted
image
install
intel
js
launch
linux
macos
memory
mlx
model
needs more info
networking
nvidia
ollama.com
performance
pull-request
Mirrored from GitHub Pull Request
 python
question
registry
rendering
thinking
tools
top
vulkan
windows
wsl
No Label documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/ollama#6118
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?