mirror of
https://github.com/SillyTavern/SillyTavern-Docs.git
synced 2026-10-15 18:01:56 +00:00
[GH-ISSUE #183] Feature Request: "RAG-Ready" Documentation #2
Labels
No labels
pull-request
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
SillyTavern/SillyTavern-Docs#2
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
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?
Originally created by @Pavdig on GitHub (Jan 10, 2026).
Original GitHub issue: https://github.com/SillyTavern/SillyTavern-Docs/issues/183
Hello team!
The Problem:
I've been trying to load the SillyTavern documentation into Open WebUI's knowledge base (RAG), but the current structure makes it difficult for LLMs to parse context correctly due to:
index.mdfiles).The Suggestion:
It would be great to have a "clean" version of the SillyTavern docs for RAG users.
Proof of Concept:
I whacked together a workflow that flattens filenames (to e.g.,
SillyTavern_Installation_index.md) and strips the metadata usingsed: Pavdig/SillyTavern-Docs-RAG.Maybe something similar could be made, but officially so that users could simply download the ZIP?
@Cohee1207 commented on GitHub (Jan 10, 2026):
Curiously enough, I thought about the same thing after noticing the Tailwind situation. I think a workflow that generates a said file and places it alongside the docs website (e.g. https://docs.sillytavern.app/llms.txt) could work for us. You think it should be multiple files?
@Pavdig commented on GitHub (Jan 10, 2026):
With my short period of using RAGs on Open WebUI and MCP servers, I believe keeping the files separated (but with correct names) is the best approach for RAG/Vector Databases for a few reasons:
Semantic Chunking:
Context via Filenames:
SillyTavern_extensions_alltalk.md), the file itself carries its own "index" or context, so the AI knows exactly what feature the text belongs to without needing a master index file.Citations & Debugging:
SillyTavern_Extensions_TTS.md). If everything is in one giant file, the source is always just "Manual.md", which makes it hard to verify where the info came from.A single monolithic file is really only suitable for "Long Context" models (dumping the whole manual into the prompt), but for an actual search/retrieval system, granular files seem to work better for me.
I lately tested cheatengine-mcp-bridge where the author used three doc files with the CE LUA documentation above 200KB in size. It works fine with Gemini 3 Pro, but after splitting it into smaller segments, it worked better, with fewer errors by executing functions, and faster.
But this is all just with... IMHO.
Do what you think is best for everyone. Everyone else has their own ways anyway. ;)
@Pavdig commented on GitHub (Feb 4, 2026):
Just a quick update on this topic.
I kept tinkering lately with my repo Pavdig/SillyTavern-Docs-RAG and managed to get the automation working properly now.
I also added a python script that bundles everything into single files (llms.txt and llms.json) alongside the standard markdown.
Feel free to use the script and workflows if you want it for the main ST docs, but otherwise, the repo is working fine for anyone who needs it.
@Cohee1207 commented on GitHub (Feb 4, 2026):
I pinned this issue just to have it handy for lurkers. I can also fork your repo under the official ST org and link it in the index.md so that it gets more recognition.
@Pavdig commented on GitHub (Feb 4, 2026):
Sounds good to me.
My intention was always for this to be a
Proof of Conceptto demonstrate the workflow, rather than maintaining a separate building block long-term.So, please go ahead. Fork it, take it or do whatever you like with it. 🤘