Skip to content

Update README.md #13

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

Merged
merged 2 commits into from
Jun 25, 2025
Merged

Update README.md #13

merged 2 commits into from
Jun 25, 2025

Conversation

mw-hrastega
Copy link
Member

No description provided.

README.md Outdated
## See Also
To generate a starter workflow for your repository, in the workflow generation interface:

1. Enter either your GitHub username followed by your repository name, or provide the full URL of your repository.
Copy link
Member

Choose a reason for hiding this comment

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

Can we show the username/repository format here. I feel like folks could interpret this to mean username SPACE repository name.

Copy link
Member Author

Choose a reason for hiding this comment

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

Would you say the following? Is it fine to have name/name?

Enter either your GitHub username/repository name or the URL of your repository.

Copy link
Member

Choose a reason for hiding this comment

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

What about just "Enter your repository URL or GitHub username and repository."?

Copy link
Member

Choose a reason for hiding this comment

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

This is how the GitHub Desktop app does it. I wonder if I should flip it on the generator too (so it says "URL or username/repository" rather than "username/repository or URL".

Screenshot 2025-06-25 at 10 25 40 AM

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, I like this better. It should be easier to copy the URL, so it can appear first.

@mw-hrastega mw-hrastega merged commit 90c463b into main Jun 25, 2025
1 check passed
@mw-hrastega mw-hrastega deleted the mw-hrastega-patch-1 branch June 25, 2025 14:35
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