Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: more verbose end-user documentation #64

Open
FitzFrobozz opened this issue Oct 28, 2024 · 1 comment
Open

Feature request: more verbose end-user documentation #64

FitzFrobozz opened this issue Oct 28, 2024 · 1 comment

Comments

@FitzFrobozz
Copy link

FitzFrobozz commented Oct 28, 2024

Hello! Great plugin. I've noticed that the getting started and how to use documentation is a little on the sparse side. Would be super if it were fleshed out more, especially for less savvy folks. As things are now I imagine the brevity may be a little intimidating and confusing for some folks.

For example, would be helpful to mention that (afaict) docker must be running during plugin use, and that running the command (docker run -d -p 9000:9000 -e ASR_MODEL=base -e ASR_ENGINE=openai_whisper onerahmet/openai-whisper-asr-webservice:latest) once per session is required for plugin use (e.g. each time after a reboot and a docker start). At least, I think that may be required; it's what I found I had to do earlier today, at any rate. [Edit: Oops, turns out the container just needed to be started, in cases where it's not running for whatever reason. I was creating new containers each time I ran that command. :D (I'm not super on top of things when it comes to Docker.)]

This all may feel like obvious info to you and others, but I'm sure it would be a great addition just the same. Putting this kind of detail into an ordered list of steps in the repo's README and also somewhere in Obsidian would be the cat's pajamas for this documentation enthusiast. Would even be happy to help you draft it & decide where to put it!

@djmango
Copy link
Owner

djmango commented Oct 29, 2024

Hey! love the idea, could you submit a PR with what you're thinking?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants