code icon indicating copy to clipboard operation
code copied to clipboard

Open README when adding project

Open cassidyjames opened this issue 7 years ago • 2 comments

I wonder if it would be valuable to automatically open the project README.md when adding a project to the sidebar? This would mean you get straight to any documentation about the project right away, and if we implement something like #340, we could even automatically open the rendered view of it which would feel like magic.

This would be nice for #135 as well instead of passing in a folder, then getting what seems like your previous session with no changes (except a tiny sidebar item non-obviously added).


Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

cassidyjames avatar May 19 '18 20:05 cassidyjames

I have a working prototype on this and can send a PR in the next days. Right now it always opens the readme when opening a new project. Should this behavior be configurable?

igordsm avatar Sep 28 '21 18:09 igordsm

I think this would be annoying unless it was smart enough to not open it for a recently used project which would mean maintaining a list of recently used projects (which admittedly could have other uses). It is easy enough to find the "README.md" file in the sidebar as it is a direct child of the root.

jeremypw avatar Oct 12 '21 11:10 jeremypw