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.

Sign up for GitHub

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

Jump to bottom

Open README when adding project #437

Open
cassidyjames opened this issue May 19, 2018 · 2 comments · May be fixed by #1108
Open

Open README when adding project #437

cassidyjames opened this issue May 19, 2018 · 2 comments · May be fixed by #1108
Labels
Priority: Wishlist An enhancement or feature request
Projects
Make it project-centric

Comments

@cassidyjames
Copy link
Contributor

cassidyjames commented May 19, 2018 •
edited by danirabbit

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.
@danirabbit danirabbit added the Priority: Wishlist An enhancement or feature request label May 20, 2018
@igordsm
Copy link
Sponsor Contributor

igordsm commented Sep 28, 2021

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 igordsm linked a pull request Oct 4, 2021 that will close this issue
Open
@jeremypw
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Priority: Wishlist An enhancement or feature request
Projects
Make it project-centric
  
Tasks
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Open README.md when opening folder. igordsm/code
4 participants
@igordsm @cassidyjames @danirabbit @jeremypw