FR: In the Guides section, link to plugin code which uses that concept
#36
Replies: 3 comments
-
|
I admit this would be really helpful to have, though I'm a little worried about the maintenance burden. Would you:
In all of these cases, we'd have to regularly reevaluate whether they are still “good” custom views. And if we introduce an “In the wild” section for one guide, we'll likely see them in other guides as well. I would struggle to keep these resources up-to-date. I think I'd prefer if we could distill what makes those custom views "good" and then add it to the guide instead. WDYT? |
Beta Was this translation helpful? Give feedback.
-
|
I get you, I get you. This way people reading would know when last someone updated the note of the example.
Good question! Given that the author might completely remove the custom view, permalinking could just break (having the date last edited would help here, too). Maybe just linking to the plugin and adding a screenshot of the thing it does well. But if you decide the admin is too much, then I think distilling the "goodness" into your guide is a fine fallback! Sticking to your guidelines, it would still have to be a working example, and then stuff comes in about copying someone else's code, no? I suppose if the plugin has an appropriate license, that's fine. |
Beta Was this translation helpful? Give feedback.
-
|
Been thinking a little more about this. If we feel a plugin is a good example, I think we should tell the reader why it's good, rather than pointing to an entire repository, or even a whole file. If we're able to do that, we should instead be able to simplify it, so it's easier to understand. For example, if we find a really good example we can create a smaller version of it where we focus on the thing we want to show, and then create a page this like one: https://marcus.se.net/obsidian-plugin-docs/examples/insert-link We would then be able to link to the plugin, but for credit rather than reference, so there's less need to keep it updated. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
For example, in the
Custom Viewssection, have a heading at the bottom which links to sections in the code of plugins which have "good" custom viewsBeta Was this translation helpful? Give feedback.
All reactions