Add documentation for codespaces use and link to a sample repo #1440
Conversation
samuelchassot
force-pushed
the
codespaces_doc
branch
from
784cad6 to
fb28c6e
Compare
There was a problem hiding this comment.
I've tried it on my side and it looks good 👍 !
@vkuncak Can we merge this?
|
@samuelchassot maybe we should write slightly more general remark on using vscode as a default IDE for Stainless? Because we are not using Scala 3 and that only really seems to work in vscode. Decoupling ssh functionality from codespaces functionality seems more to the point of what workflow we recommend. |
@vkuncak I agree on the VSCode as default IDE, that sounds good! Concerning the SSH, it would indeed be good to mention. I don't think it would apply to as many people, as it requires to own and setup a server. |
There was a problem hiding this comment.
Can you remove scala 2 references in the example repo https://github.com/samuelchassot/Stainless-codespaces Then we can link the documentation change.
README.md
Outdated
| @@ -98,6 +98,10 @@ See [frontends/benchmarks/verification/valid/](frontends/benchmarks/verification | |||
| [bolts repository](https://github.com/epfl-lara/bolts/) for a larger collection. | |||
| More information is available in the documentation links. | |||
|
|
|||
| ### Github Codespaces | |||
|
|
|||
| We also provide a sample repository to use Stainless with Github Codespaces. These allow to use Stainless without installing anything on your machine. Github Codespaces are cloud machines that can be access via Visual Studio Code locally or in the browser. See [this sample](https://github.com/samuelchassot/Stainless-codespaces) repository to get started. | |||
There was a problem hiding this comment.
Can you give some high-level hints, so we provide here more than a pointer to the other repository? Perhaps also clarify which aspects of Stainless and GitHub make it work smoothly (so people can think of setting up similar things). A related question is: how easy it is to set up a GitHub runner that uses Stainless.
There was a problem hiding this comment.
@samuelchassot I suggest the following rewrite. Also, please fix the broken link to stainless steel that you have on your web page.
Github Codespaces
To allow running Stainless with only a browser, we have provided a sample repository to use Stainless with Github Codespaces. Github Codespaces are cloud machines that can be access via Visual Studio Code locally or in the browser. In our experience (as of October 2023), this flow works well, given the provided Ubuntu Linux virtual machines with 16GB of RAM and substantial processing power. Please see the repository for further details.
Done! |
No description provided.