You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Help wanted: making KOAssistant easier to learn
#57
I'm the sole developer of KOAssistant, and I've noticed a pattern: users often find the plugin overwhelming at first, but once someone walks them through a feature, they end up loving it. The problem is discovery — the README has grown to thousands of lines trying to document everything, and that's clearly not the right format for helping new users get started.
What I'm doing about it: I've started a wiki with a few AI made starter pages — Getting Started, Using X-Ray, and a Contributing guide. They're intentionally short and simple — that's the format I'm going for. Practical walkthroughs, not exhaustive reference docs.
Where you come in: If you're comfortable with KOAssistant and want to help others get there too, I'd love your help expanding the wiki.
Pages we need
Here's a wishlist. If any of these match your experience, even a rough draft is hugely valuable:
Setting up Ollama (local AI) with KOAssistant
Using Behaviors to customize AI responses
Using Domains for subject expertise
Creating custom actions
Dictionary integration walkthrough
Bypass modes (skip menus, instant AI actions)
Notebooks and Obsidian integration
Managing conversations (history, export, tags)
Multi-document features
Tips for better results (model choice, temperature)
Research Mode for academic papers
Troubleshooting common issues
Screenshots are gold
E-reader UIs are hard to describe in words. If you can capture a few screenshots showing how you use a feature, that alone is a massive contribution — even without writing a full guide. I can build the text around your screenshots.
Translations welcome
KOAssistant supports 20 UI languages and 47 AI languages — many users don't read English comfortably. If you speak another language, you can:
Write a guide directly in your language — original content in any language is great
Translate an existing page using AI — just add a note at the top saying it was AI-translated so native speakers know to refine it
Improve an AI translation — if you see a translated page that reads awkwardly, fix it
Page naming convention: Getting-Started-FR, Using-X-Ray-AR, etc.
How to contribute
Anyone with a GitHub account can edit the wiki directly — click "Edit" on any page or "New Page" to create one. No pull request needed. The Contributing page has full guidelines, but the short version is: keep it practical, keep it short, imperfect is fine.
Thanks for using KOAssistant, and thanks in advance if you decide to help out here. Even fixing a typo, adding one screenshot, or translating a page counts.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
Hey everyone,
I'm the sole developer of KOAssistant, and I've noticed a pattern: users often find the plugin overwhelming at first, but once someone walks them through a feature, they end up loving it. The problem is discovery — the README has grown to thousands of lines trying to document everything, and that's clearly not the right format for helping new users get started.
What I'm doing about it: I've started a wiki with a few AI made starter pages — Getting Started, Using X-Ray, and a Contributing guide. They're intentionally short and simple — that's the format I'm going for. Practical walkthroughs, not exhaustive reference docs.
Where you come in: If you're comfortable with KOAssistant and want to help others get there too, I'd love your help expanding the wiki.
Pages we need
Here's a wishlist. If any of these match your experience, even a rough draft is hugely valuable:
Screenshots are gold
E-reader UIs are hard to describe in words. If you can capture a few screenshots showing how you use a feature, that alone is a massive contribution — even without writing a full guide. I can build the text around your screenshots.
Translations welcome
KOAssistant supports 20 UI languages and 47 AI languages — many users don't read English comfortably. If you speak another language, you can:
Page naming convention:
Getting-Started-FR,Using-X-Ray-AR, etc.How to contribute
Anyone with a GitHub account can edit the wiki directly — click "Edit" on any page or "New Page" to create one. No pull request needed. The Contributing page has full guidelines, but the short version is: keep it practical, keep it short, imperfect is fine.
Thanks for using KOAssistant, and thanks in advance if you decide to help out here. Even fixing a typo, adding one screenshot, or translating a page counts.
All reactions