The new "How to use Codespaces in your project" page replaces the existing "How to use GitHub Codespaces" page. The new page should contain information about Codespaces started from the research dev container and opened inside a browser. It should briefly describe how to complete common tasks:
start RStudio
run opensafely in the Terminal pane
~create a commit from the Source Control pane~ (point to #45)
~push a set of commits from the Source Control pane~ (point to #45)
start, stop, and delete a Codespace
The new page should avoid:
screenshots. These need to be updated regularly and are more suited to a tutorial.
a discussion of workflows. Researchers should decide the order of common tasks.
information about Codespaces and dev containers in general. This needs to be updated regularly and is beyond our control.
information about Codespaces opened outside a browser (e.g. opened in Visual Studio Code, JetBrains Gateway, JupyterLab). This needs to be updated regularly and is beyond our control.
There isn't a need to diff between new and existing files, so create a new file and delete the existing file. Add a redirect to docs/_redirects, though.
If you're unsure what makes documentation good, or just unsure why I'm enclosing links in quotation marks, then read:
The new "How to use Codespaces in your project" page replaces the existing "How to use GitHub Codespaces" page. The new page should contain information about Codespaces started from the research dev container and opened inside a browser. It should briefly describe how to complete common tasks:
opensafelyin the Terminal paneThe new page should avoid:
Instead, link to external documentation, such as the "The github.dev web-based editor" page in the GitHub docs.
There isn't a need to diff between new and existing files, so create a new file and delete the existing file. Add a redirect to
docs/_redirects, though.If you're unsure what makes documentation good, or just unsure why I'm enclosing links in quotation marks, then read: