d12frosted / vulpea

A collection of functions for note taking based on `org` and `org-roam`.
GNU General Public License v3.0
236 stars 12 forks source link

Clarification #147

Closed joyguar closed 1 year ago

joyguar commented 1 year ago

This isn't an issue, I'm trying to understand the benefits of vulpea that you describe. You use the phrase "consistent experience" a few places: "vulpea-find that acts like org-roam-node-find, but (a) uses vulpea-select for consistent experience" You use the same phrase "consistent experience" to describe how vulpea-select benefits vulpea-insert as well. How does the use of vulpea-select provide a more "consistent experience" in these cases?

d12frosted commented 1 year ago

Hey @danielclucas

Oh, I didn't mean that it provides more consistent behaviour that Org Roam functions. I definitely need to rephrase these. What I meant, functions provided by Vulpea that allow one to interactively select a note use vulpea-select - and this makes them consistent. Wanted emphasise that there is vulpea-select that can be configured and used programatically in more places 🤔 Does it make sense now?

I will think about different phrasing that is also consice. Will share later.

joyguar commented 1 year ago

Ahhhh, I understand your meaning now. I think it would help to change that wording. Thank you for the clarification.

Because we are on the topic of your README, I have a suggestion for you. In the past I naively assumed that the vulpea database was a separate database which duplicated data from the org-roam database. I was pleasantly surprised to learn that all vulpea does is inject new data into the org-roam database to create the vulpea database. This makes sense, and it wouldn't surprise me if the latter is a standard practice in these kinds of situations. It might be a good idea to quickly mention how the vulpea database is created, i.e. by injecting new data into the org-roam db.