[PR #29] [CLOSED] Added new guides, faq, updated installtion guides, re-organized sidebar items and much more... #87

Closed
opened 2026-02-23 17:19:39 -05:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/Mintplex-Labs/anythingllm-docs/pull/29
Author: @ShadowArcanist
Created: 5/23/2024
Status: Closed

Base: mainHead: Docs-v2


📝 Commits (9)

  • 12b6920 ♻️ Re-organized Sidebar Items
  • e3acd48 ♻️ Re-named image name "thumbnail" to "header-image"
  • 5646cb9 Fixed Contact us email
  • 7a5a8d8 ♻️ Updated and restructured Agent guides
  • 996acb4 ⬆️ Updated Installation + other Guides
  • 1dd010b 🐛 Fixed Broken Links
  • 27b83be ⬆ Updated Readme + Bumped Docs Version
  • bcb2e12 Added Ollama models not showing - FAQ
  • 71af83f Implemented changes requested by Luna Midori

📊 Changes

193 files changed (+968 additions, -657 deletions)

View changed files

📝 README.md (+12 -9)
📝 package.json (+1 -1)
📝 pages/_meta.json (+112 -29)
📝 pages/agent/_meta.json (+6 -8)
pages/agent/overview.mdx (+66 -0)
📝 pages/agent/setup.mdx (+3 -9)
📝 pages/agent/usage.mdx (+28 -24)
📝 pages/changelog/_meta.json (+0 -0)
📝 pages/changelog/overview.mdx (+3 -3)
📝 pages/changelog/v1.5.3.mdx (+1 -1)
📝 pages/changelog/v1.5.4.mdx (+1 -1)
📝 pages/cloud/_meta.json (+0 -0)
📝 pages/cloud/error-502.mdx (+0 -0)
📝 pages/cloud/limitations.mdx (+0 -0)
📝 pages/cloud/overview.mdx (+1 -1)
📝 pages/contribute.mdx (+2 -3)
pages/debug.mdx (+27 -0)
pages/faq/_meta.json (+0 -11)
📝 pages/features/ai-agents.mdx (+1 -1)
📝 pages/features/all-features.mdx (+16 -16)

...and 80 more files

📄 Description

Pull Request Type

  • feat
  • 🐛 fix
  • ♻️ refactor

Relevant Issues

resolves #22 #28

What is in this change?

♻️ Re-organized Sidebar Items

  • Split the folders on the sidebar and created sections like "Getting Started", "Guides", "FAQs"

♻️ Re-named image name "thumbnail" to "header-image"

  • We were using images on each page header but all the image names were called "thumbnail", since we
    are primarily using the images on header on all the pages I renamed it to "header-image" and updated
    all the file paths

♻️ Updated and restructured Agent guides

  • Split the Agent guides into 3 different pages -- Overview, Setup, Usage

⬆️ Updated Installation Guides [ MacOS, Linux, Windows & Docker ]

  • Updated the MacOS, Linux & Windows installation guides to be more beginner friendly
  • Copy pasted the entire Docker guide on github to the docs so that all the guides will be on one place
  • Updated information about Midori AI Sub-system manager on docker guide

Added new pages (guides) for how to uninstall, update anythingllm and run anythingllm on debug mode

  • We used have update and uninstall guide along with the installation guide but most people didn't know that, so I have created separate pages for uninstall, update and debug mode.

Added Ollama Models not showing - FAQ

💬 Minor changes

  • Fixed all broken links (I broke them while Re-organizing the sidebar items)
  • Updated the Readme file
  • Bumped Docs Version

Additional Information

  • On Ollama Models not showing - FAQ, I used the information from Docker Readme but I don't use docker myself, so it would be great if you could verify the information on the FAQ is correct
  • On Uninstall, Update, Debug I have left some comments about the information that needs to be added to the page in the near future
  • You can view the updated version of the docs with the above changes on https://anything-llm-docs.vercel.app/

Validations

  • Ensured updated documentation pass spell check
  • Updated or added relevant links as needed
  • Reviewed the changes for clarity and accuracy
  • Successfully ran the code locally without encountering errors

🔄 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/Mintplex-Labs/anythingllm-docs/pull/29 **Author:** [@ShadowArcanist](https://github.com/ShadowArcanist) **Created:** 5/23/2024 **Status:** ❌ Closed **Base:** `main` ← **Head:** `Docs-v2` --- ### 📝 Commits (9) - [`12b6920`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/12b69206303c235ef428cb38fda18191989a4cbd) ♻️ Re-organized Sidebar Items - [`e3acd48`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/e3acd48d4a72018a9a1dc11f00e66e96461be2c9) ♻️ Re-named image name "thumbnail" to "header-image" - [`5646cb9`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/5646cb92806ab917a86170e70851d7f4f841dbf2) ✅ Fixed Contact us email - [`7a5a8d8`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/7a5a8d8954f3148fe713fdbcbfeb1a294f065232) ♻️ Updated and restructured Agent guides - [`996acb4`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/996acb4387b7ed3294f6f86470fee5be3d0b7da4) ⬆️ Updated Installation + other Guides - [`1dd010b`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/1dd010bb767703329735c77edde59c28c86f2593) 🐛 Fixed Broken Links - [`27b83be`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/27b83be6d9c7148b6a51ff96ba0e490c749cba03) ⬆ Updated Readme + Bumped Docs Version - [`bcb2e12`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/bcb2e12f1e3f62229a8809835dd20996cb238db6) ✨ Added Ollama models not showing - FAQ - [`71af83f`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/71af83f93603509c009f7e6d4d53233b3636538c) ⚡Implemented changes requested by Luna Midori ### 📊 Changes **193 files changed** (+968 additions, -657 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+12 -9) 📝 `package.json` (+1 -1) 📝 `pages/_meta.json` (+112 -29) 📝 `pages/agent/_meta.json` (+6 -8) ➕ `pages/agent/overview.mdx` (+66 -0) 📝 `pages/agent/setup.mdx` (+3 -9) 📝 `pages/agent/usage.mdx` (+28 -24) 📝 `pages/changelog/_meta.json` (+0 -0) 📝 `pages/changelog/overview.mdx` (+3 -3) 📝 `pages/changelog/v1.5.3.mdx` (+1 -1) 📝 `pages/changelog/v1.5.4.mdx` (+1 -1) 📝 `pages/cloud/_meta.json` (+0 -0) 📝 `pages/cloud/error-502.mdx` (+0 -0) 📝 `pages/cloud/limitations.mdx` (+0 -0) 📝 `pages/cloud/overview.mdx` (+1 -1) 📝 `pages/contribute.mdx` (+2 -3) ➕ `pages/debug.mdx` (+27 -0) ➖ `pages/faq/_meta.json` (+0 -11) 📝 `pages/features/ai-agents.mdx` (+1 -1) 📝 `pages/features/all-features.mdx` (+16 -16) _...and 80 more files_ </details> ### 📄 Description ### Pull Request Type <!-- For change type, change [ ] to [x]. --> - [x] ✨ feat - [x] 🐛 fix - [x] ♻️ refactor ### Relevant Issues <!-- Use "resolves #xxx" to auto resolve on merge. Otherwise, please use "connect #xxx" --> resolves #22 #28 ### What is in this change? <!-- Describe the changes in this PR that are impactful to the documentation site. --> #### ♻️ Re-organized Sidebar Items - Split the folders on the sidebar and created sections like "Getting Started", "Guides", "FAQs" #### ♻️ Re-named image name "thumbnail" to "header-image" - We were using images on each page header but all the image names were called "thumbnail", since we are primarily using the images on header on all the pages I renamed it to "header-image" and updated all the file paths #### ♻️ Updated and restructured Agent guides - Split the Agent guides into 3 different pages -- Overview, Setup, Usage #### ⬆️ Updated Installation Guides [ MacOS, Linux, Windows & Docker ] - Updated the MacOS, Linux & Windows installation guides to be more beginner friendly - Copy pasted the entire [Docker guide on github](https://github.com/Mintplex-Labs/anything-llm/blob/master/docker/HOW_TO_USE_DOCKER.md) to the docs so that all the guides will be on one [place](https://docs.useanything.com/) - Updated information about Midori AI Sub-system manager on docker guide #### ✨ Added new pages (guides) for how to uninstall, update anythingllm and run anythingllm on debug mode - We used have update and uninstall guide along with the installation guide but most people didn't know that, so I have created separate pages for uninstall, update and debug mode. #### ✨ Added Ollama Models not showing - FAQ #### 💬 Minor changes - Fixed all broken links (I broke them while Re-organizing the sidebar items) - Updated the Readme file - Bumped Docs Version ### Additional Information <!-- Add any other context about the Pull Request here that was not captured above. --> - On Ollama Models not showing - FAQ, I used the information from [Docker Readme](https://github.com/Mintplex-Labs/anything-llm/blob/master/docker/HOW_TO_USE_DOCKER.md) but I don't use docker myself, so it would be great if you could verify the information on the FAQ is correct - On Uninstall, Update, Debug I have left some comments about the information that needs to be added to the page in the near future - You can view the updated version of the docs with the above changes on https://anything-llm-docs.vercel.app/ ### Validations <!-- All of the applicable items should be checked. --> - [x] Ensured updated documentation pass spell check - [x] Updated or added relevant links as needed - [x] Reviewed the changes for clarity and accuracy - [x] Successfully ran the code locally without encountering errors --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-23 17:19:39 -05:00
yindo closed this issue 2026-02-23 17:19:39 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Mintplex-Labs/anythingllm-docs#87