Skip to content

Docs: Add instructions for renaming and managing codespaces (closes #229) #250

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

Open
wants to merge 2 commits into
base: devel
Choose a base branch
from
Open

Docs: Add instructions for renaming and managing codespaces (closes #229) #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
baa85fd
docs: add instructions for renaming codespace display name after crea…
avinab-neogy Jun 19, 2025
7ae4dc7
fix linter issues
avinab-neogy Jun 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/rdev3_5.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions docs/container_setup/github_codespace/creating_codespace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,27 @@ GitHub Codespaces' button and then click the green 'Create Codespace' button.

3. You will be taken to a VSCode editor within your browser.
![codespace](../../assets/rdev3.png)

4. Rename your codespace for easier identification:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. Rename your codespace for easier identification:
4. Rename your codespace for easier identification.


By default, your codespace will have a randomly generated name. Renaming it to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From this line onwards the indentation is incorrect. At least the first line of each paragraph and the first line of each bullet point should be indented four spaces so that it aligns to the right of the item number (4.). I recommend to indent all of the lines 4 spaces, to make it clearer in the markdown file that this content is part of listed item, rather than new content after the list.

something descriptive — such as referencing the issue or feature you’re working
on makes it much easier to find and manage your codespaces, especially if
you use several.

To rename your codespace:**
Comment on lines +27 to +30
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
on makes it much easier to find and manage your codespaces, especially if
you use several.
To rename your codespace:**
on - makes it much easier to manage your codespaces:

Try to keep the text succinct (so people bother to read it!) and avoid repetition


- Open your [GitHub Codespaces dashboard](https://github.com/codespaces) in
your browser.
- Find the codespace you just created (it will show the repository name and
the current random display name).
- Click the ellipsis (**...**) next to your codespace to open the options menu.
- Select **Rename** from the dropdown.
- Enter a descriptive new display name (e.g., `r-dev-env-issue-229` or
`r-dev-env-patch-naming`) and confirm.
Comment on lines +38 to +39
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Enter a descriptive new display name (e.g., `r-dev-env-issue-229` or
`r-dev-env-patch-naming`) and confirm.
- Enter a descriptive new display name, e.g., `Bug 7084 - text() recycling problems` or `Ignore deprecated/defunct fns in checkS3methods`, and confirm.

Remember the container is intended for working on bugs/features in R, not issues with the R dev container. It is not necessary to include r-dev-env in the name, as this is already shown (as you point out in the second bullet point here).


![rename codespace](../../assets/rdev3_5.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As this screenshot is intended to show how to select 'Rename', it would be good to have the current name be three random words. Also it would be great if you could find a tool that lets you take screenshots that show the cursor, as the change in colour under 'Rename' is not obvious. If this is not possible, perhaps you could post-edit the screenshot to add a red oval around the 'Rename' menu item. It would also be good to switch to light mode as the previous screen shot is in light mode (I fear we are not consistent across the docs, but I think it would be good be consistent on the same page). Finally, while I am a fan of screenshots where you can read the text, this is a bit too zoomed in. Aim for a zoom level where the regular text (like 'Rename') is a similar size to the normal text in the docs.


> **Tip:**
> You can rename your codespace at any time. The display name is
for your convenience and does not affect your code or environment.
Comment on lines +43 to +45
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should use an admonition block of type "tip" here, see https://squidfunk.github.io/mkdocs-material/reference/admonitions/#+type:tip