search

daytonaio / daytona

The Open Source Dev Environment Manager.
https://daytona.io
Apache License 2.0
11.89k stars 851 forks source link

daytona should show README file when project opens #1294

Open divanshu-go opened 1 month ago

divanshu-go commented 1 month ago

Is your feature request related to a problem? Please describe. When opening a project in Daytona, the README file isn’t automatically displayed, which can be frustrating as it's often needed for setup, usage, or guidelines

Describe the solution you'd like Daytona automatically show the README upon project open, giving instant access to essential documentation.

Additional context For SSH sessions we can do something like cat README.md or less README.md

Tpuljak commented 1 month ago

@divanshu-go thanks for the feature suggestion.

The Daytona CLI couldn't not do this reliably. Instead, an IDE extension should be responsible for this. We have relevant issues for creating a VS Code and Jetbrains extensions in our roadmap and will move this issue on the respective repos once we get that going.

We can keep the issue here until then.

For SSH sessions we can do something like cat README.md or less README.md

Regarding this, I believe we should avoid this because it would bloat the SSH output every single time and don't think it would benefit the user much.

divanshu-go commented 1 month ago

regarding VS code , we can install this extension it will auto-open the README also it will only open the README for the first time only.

Tpuljak commented 4 weeks ago

regarding VS code , we can install this extension it will auto-open the README also it will only open the README for the first time only.

Let's stick with the plan for our extension.

hadywalied commented 3 weeks ago

may I suggest using find on linux and passing the output to the code command when starting vscode, I think this should start the project on the readme file, and if no readme file found we can open code . I mean just some shell scripting.

Tpuljak commented 3 weeks ago

may I suggest using find on linux and passing the output to the code command when starting vscode, I think this should start the project on the readme file, and if no readme file found we can open code . I mean just some shell scripting.

@hadywalied that can work fine, you're correct but having our extension would allow us more flexibility and implement opening files defined in the devcontainer configuration as well.