search

djmango / obsidian-transcription

Obsidian plugin to create high-quality transcriptions from markdown linked audio files
https://swiftink.io
MIT License
160 stars 17 forks source link

Feature request: more verbose end-user documentation #64

Open FitzFrobozz opened 3 weeks ago

FitzFrobozz commented 3 weeks ago

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 commented 3 weeks ago

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