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

What does the plugin do? #41

Open
davidjroos opened this issue Aug 5, 2023 · 2 comments
Open

What does the plugin do? #41

davidjroos opened this issue Aug 5, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation planned Planned for the next release

Comments

@davidjroos
Copy link

Just saw your update on Discord but (like a lot of plugins!) I’m not entire sure what it does from the documentation.

This plug-in is probably/possibly useful to lots of people but they won’t know because the rocs don’t really describe the problem being solved.

At a minimum some screenshots of without/with plug-in would help!

@nathonius
Copy link
Owner

Well screenshots wouldn't be too helpful since nothing changes visually. 😬 A while ago, before obsidian had a built-in way to collapse and expand all the folders in the file explorer, this plugin added a button to do that.

Then obsidian added that to core, so this plugin's usefulness was diminished. However, it still retained a few benefits over the official collapse/expand implementation, namely that it added commands to the command palette to collapse and expand. These could be bound to hotkeys.

So now I've reworked the plugin to use obsidian's internal collapse/expand functionality instead of my own, and add commands to access all those collapse and expand functions.

Hopefully that's a little clearer - I'll update the readme and plugin description to hopefully help people understand what this does now.

@nathonius nathonius changed the title [Documentation] Unclear what it does What does the plugin do? Aug 6, 2023
@nathonius nathonius added documentation Improvements or additions to documentation planned Planned for the next release labels Aug 6, 2023
@nathonius nathonius pinned this issue Aug 6, 2023
@davidjroos
Copy link
Author

Well screenshots wouldn't be too helpful since nothing changes visually. 😬 A while ago, before obsidian had a built-in way to collapse and expand all the folders in the file explorer, this plugin added a button to do that.

Then obsidian added that to core, so this plugin's usefulness was diminished. However, it still retained a few benefits over the official collapse/expand implementation, namely that it added commands to the command palette to collapse and expand. These could be bound to hotkeys.

So now I've reworked the plugin to use obsidian's internal collapse/expand functionality instead of my own, and add commands to access all those collapse and expand functions.

Hopefully that's a little clearer - I'll update the readme and plugin description to hopefully help people understand what this does now.

Ah! Yes, and definitely a useful additional and I had no idea that it was something I'd like to be able to do, I love making keyboard shortcuts for interface navigation!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation planned Planned for the next release
Projects
None yet
Development

No branches or pull requests

2 participants