Skip to content

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

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.

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 1 commit into
base: devel
Choose a base branch
from

Conversation

avinab-neogy
Copy link
Collaborator

This PR updates the contributor documentation to add a new step for renaming GitHub Codespaces after creation. The new instructions guide users on how to change the codespace display name for easier identification, especially when working on multiple issues or features.

These changes address issue #229.

@avinab-neogy avinab-neogy requested a review from hturner July 16, 2025 13:46
@avinab-neogy avinab-neogy self-assigned this Jul 16, 2025
Copy link
Member

@hturner hturner left a comment

Choose a reason for hiding this comment

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

This is nearly there, but currently only partly resolves #229.

You also need to add a step 5: Turn off auto-delete. This will need a similar screenshot to step 4.

Comment on lines +28 to +30
on makes it much easier to find and manage your codespaces:

**To Rename your codespace:**
Copy link
Member

Choose a reason for hiding this comment

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

As previously suggested (do not need line 30 here as it duplicates what is on line 24)

Suggested change
on makes it much easier to find and manage your codespaces:
**To Rename your codespace:**
on makes it much easier to manage your codespaces:

Copy link
Member

Choose a reason for hiding this comment

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

From the screenshot, it is a bit hard to work out what's going on. I think it would help to highlight the ellipsis, mark that as "A" or "1", then highlight "Rename" as you have done, but mark that "B" or "2", to show the sequence of events.


**To Rename your codespace:**

- Open your [GitHub Codespaces dashboard](https://github.com/codespaces) in
Copy link
Member

Choose a reason for hiding this comment

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

I think it's useful for people to know the url - I often get people to type it in directly.

Suggested change
- Open your [GitHub Codespaces dashboard](https://github.com/codespaces) in
- Open your [GitHub Codespaces dashboard](https://github.com/codespaces) (https://github.com/codespaces) in

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants