User Documentation?

[mblumberg]

Would be great to have some basic user-documentation. – I'm not quite clear what this plugin is intended to do.

For instance: I'd like to synch the content in my Matter "Queue" (and perhaps "Archive") to Obsidian.
This does not seem to be working – I'm not sure if this is an issue or a feature request? (Does the plugin, for instance, only synch notes and highlights? Are there settings/options anywhere to specify what's synched and what not? etc.)

[hunterclarke]

Hey Matt, thanks for the issue.

We do mention that it only syncs highlights and notes in the README and the extension documentation:

But maybe that's not where you expected to find that info. Is there someplace else you were looking?

[mblumberg]

Thanks, Hunter. I guess that first sentence of a ReadMe is on the one hand the most obvious place you could put it. On the other hand I generally read such top-line descriptions as a kind of broad statement, and generally don't assume them to be complete descriptions of a product. Said another way: because the main Matter service does so many things, I read that sentence, in that context, as meaning "synch with Matter" in a generic way. (*N.b.: I'm new to your service, so terms with specific meaning in your app are as yet unknown to me)

So, I guess [1] I'd suggest some general documentation - perhaps here in the git-hub wiki, or wherever you have service documentation. Doesn't have to be much; I guess you'll see where people are getting confused from various support requests, like this one, and could built it over time.

Also [2] a feature request: It'd be quite nice to be able to synch queue and archive to Obsidian. (My use case: I'm undertaking a long-term research project, and would very much like to have a local copy of my source material. – I've been doing this with Evernote for a while, but your service otherwise looks much better for my purposes.)

[2b]: FWIW, the ideal case would be some settings within the Matter plugin, to define what does/doesn't get synched. (Including: Synch only items with a specific tag)

[Thomasevano]

Thanks, Hunter. I guess that first sentence of a ReadMe is on the one hand the most obvious place you could put it. On the other hand I generally read such top-line descriptions as a kind of broad statement, and generally don't assume them to be complete descriptions of a product. Said another way: because the main Matter service does so many things, I read that sentence, in that context, as meaning "synch with Matter" in a generic way. (*N.b.: I'm new to your service, so terms with specific meaning in your app are as yet unknown to me)

So, I guess [1] I'd suggest some general documentation - perhaps here in the git-hub wiki, or wherever you have service documentation. Doesn't have to be much; I guess you'll see where people are getting confused from various support requests, like this one, and could built it over time.

Also [2] a feature request: It'd be quite nice to be able to synch queue and archive to Obsidian. (My use case: I'm undertaking a long-term research project, and would very much like to have a local copy of my source material. – I've been doing this with Evernote for a while, but your service otherwise looks much better for my purposes.)

[2b]: FWIW, the ideal case would be some settings within the Matter plugin, to define what does/doesn't get synched. (Including: Synch only items with a specific tag)

If you want to save the entire article to Obsidian there is a script to have as favorite in you browser that can do that: https://gist.github.com/kepano/90c05f162c37cf730abb8ff027987ca3