anythingllm-docs icon indicating copy to clipboard operation
anythingllm-docs copied to clipboard

✨ Added new guides, faq, updated installtion guides, re-organized sidebar items and much more...

Open ShadowArcanist opened this issue 1 year ago • 1 comments

Pull Request Type

  • [x] ✨ feat
  • [x] 🐛 fix
  • [x] ♻️ 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

  • [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

ShadowArcanist avatar May 23 '24 14:05 ShadowArcanist

@ShadowArcanist is attempting to deploy a commit to the Mintplex Labs Inc Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar May 23 '24 14:05 vercel[bot]