github-starred/ollama
2
0
Fork 0
mirror of https://github.com/ollama/ollama.git synced 2026-05-07 08:30:05 -05:00
Code Issues 14.5k Packages Projects Releases 120 Wiki Activity

[GH-ISSUE #1744] 💡 Idea/Suggestion: Rich API Documentation #998

New Issue
Open
opened 2026-04-12 10:42:36 -05:00 by GiteaMirror · 1 comment
GiteaMirror commented 2026-04-12 10:42:36 -05:00
Owner
Copy Link

Originally created by @amithkoujalgi on GitHub (Dec 30, 2023).
Original GitHub issue: https://github.com/ollama/ollama/issues/1744

Hello @jmorganca.

First of all, thank you for your amazing work! 🤩 I have been using Ollama for a while now and I'm really enjoying it.

I was wondering if we could introduce a API documentation website (right from GitHub using GH Pages). Along with this we could also have a GitHub action workflow setup to auto-build and deploy the API documentation when a release is created.

I think it would be greatly helpful for someone to get started with basics (including setup, how and why Ollama is used, etc) and then progressively navigate through the documentation to explore more and try more advanced stuff via a more user-friendly UI.

I was thinking if I could setup a skeleton structure for the documentation using docusaurus. That way, we can have well structured comprehensive API documentation such as this.

Let me know what you think. Thanks!

Originally created by @amithkoujalgi on GitHub (Dec 30, 2023). Original GitHub issue: https://github.com/ollama/ollama/issues/1744 Hello @jmorganca. First of all, thank you for your amazing work! 🤩 I have been using Ollama for a while now and I'm really enjoying it. I was wondering if we could introduce a API documentation website (right from GitHub using GH Pages). Along with this we could also have a GitHub action workflow setup to auto-build and deploy the API documentation when a release is created. I think it would be greatly helpful for someone to get started with basics (including setup, how and why Ollama is used, etc) and then progressively navigate through the documentation to explore more and try more advanced stuff via a more user-friendly UI. I was thinking if I could setup a skeleton structure for the documentation using [docusaurus](https://docusaurus.io/). That way, we can have well structured comprehensive API documentation such as [this](https://amithkoujalgi.github.io/ollama4j/docs/intro). Let me know what you think. Thanks!
GiteaMirror added the documentationfeature requestapi labels 2026-04-12 10:42:36 -05:00
GiteaMirror commented 2026-04-12 10:42:37 -05:00
Author
Owner
Copy Link

@igorschlum commented on GitHub (Dec 30, 2023):

@amithkoujalgi I'm OK to help working on the API with you and others. I look the documentation made for Ollama4j and it's very nice.

<!-- gh-comment-id:1872585582 --> @igorschlum commented on GitHub (Dec 30, 2023): @amithkoujalgi I'm OK to help working on the API with you and others. I look the documentation made for Ollama4j and it's very nice.
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 api documentation feature request
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#998
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?