[PR #1506] [MERGED] Clean up documentation #10604

Closed
opened 2026-04-12 23:04:42 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/ollama/ollama/pull/1506
Author: @technovangelist
Created: 12/13/2023
Status: Merged
Merged: 12/22/2023
Merged by: @technovangelist

Base: mainHead: mattw/docrun


📝 Commits (10+)

  • 62bce45 Clean up documentation
  • 605413b Merge branch 'main' into mattw/docrun
  • ae1b82a Correcting to fit in 0.1.15 changes
  • 20dffa3 Update README.md
  • bb0130d addressing comments
  • 01efee2 Merge branch 'main' of github.com:jmorganca/ollama into mattw/docrun
  • 9cdaa45 more api cleanup
  • 9351068 its llava not llama
  • e0b077a Update docs/troubleshooting.md
  • 4980bd0 Updated hosting to server and documented all env vars

📊 Changes

7 files changed (+367 additions, -236 deletions)

View changed files

📝 README.md (+5 -1)
📝 docs/README.md (+23 -4)
📝 docs/api.md (+269 -135)
📝 docs/faq.md (+43 -91)
📝 docs/import.md (+1 -1)
📝 docs/modelfile.md (+4 -4)
docs/troubleshooting.md (+22 -0)

📄 Description

Will probably need to update with PRs for new release.

This accomplishes a few things.

  • First it looks at the api docs, makes them a bit more consistent, and fixes the requests and responses to reflect how they actually work today.
  • It creates a better README for the docs folder
  • Creates a DeepDive for understanding the files and layers using the api (inspired by the gdev doc Jeff shared)
  • Creates a troubleshooting guide that starts to share the common solutions to some error messages that pop up.
  • Moves some of the FAQ questions into more appropriate places in the docs.

I think that’s it.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/ollama/ollama/pull/1506 **Author:** [@technovangelist](https://github.com/technovangelist) **Created:** 12/13/2023 **Status:** ✅ Merged **Merged:** 12/22/2023 **Merged by:** [@technovangelist](https://github.com/technovangelist) **Base:** `main` ← **Head:** `mattw/docrun` --- ### 📝 Commits (10+) - [`62bce45`](https://github.com/ollama/ollama/commit/62bce454f0de388c70b8e85634a7286bcd681039) Clean up documentation - [`605413b`](https://github.com/ollama/ollama/commit/605413b1904afcc652a6e88b391216e91440ca1e) Merge branch 'main' into mattw/docrun - [`ae1b82a`](https://github.com/ollama/ollama/commit/ae1b82a2b4fea1c5e6103d6c4d56718eb87b19ca) Correcting to fit in 0.1.15 changes - [`20dffa3`](https://github.com/ollama/ollama/commit/20dffa3278654402495a7008c8cdc735f63ca555) Update README.md - [`bb0130d`](https://github.com/ollama/ollama/commit/bb0130d4a3df5bdd6437cd0e406bd2f130840f81) addressing comments - [`01efee2`](https://github.com/ollama/ollama/commit/01efee2d6c27185ed33fecab4fac63327b35a80e) Merge branch 'main' of github.com:jmorganca/ollama into mattw/docrun - [`9cdaa45`](https://github.com/ollama/ollama/commit/9cdaa453d876df865b6d706146d5f0383dd1910b) more api cleanup - [`9351068`](https://github.com/ollama/ollama/commit/9351068b7680b21614e5de0fb6888ab084ec4c37) its llava not llama - [`e0b077a`](https://github.com/ollama/ollama/commit/e0b077a8f51f98c499910e558650690f51e15398) Update docs/troubleshooting.md - [`4980bd0`](https://github.com/ollama/ollama/commit/4980bd0a5b718e581601e699f0a2f33ca5df9929) Updated hosting to server and documented all env vars ### 📊 Changes **7 files changed** (+367 additions, -236 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+5 -1) 📝 `docs/README.md` (+23 -4) 📝 `docs/api.md` (+269 -135) 📝 `docs/faq.md` (+43 -91) 📝 `docs/import.md` (+1 -1) 📝 `docs/modelfile.md` (+4 -4) ➕ `docs/troubleshooting.md` (+22 -0) </details> ### 📄 Description Will probably need to update with PRs for new release. This accomplishes a few things. - First it looks at the api docs, makes them a bit more consistent, and fixes the requests and responses to reflect how they actually work today. - It creates a better README for the docs folder - Creates a DeepDive for understanding the files and layers using the api (inspired by the gdev doc Jeff shared) - Creates a troubleshooting guide that starts to share the common solutions to some error messages that pop up. - Moves some of the FAQ questions into more appropriate places in the docs. I think that’s it. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-12 23:04:42 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/ollama#10604