Skip to content
This repository has been archived by the owner on Feb 21, 2024. It is now read-only.

docs: fixed copy format and command #146

Merged
merged 3 commits into from
Jan 26, 2024

Conversation

MrSagarShah
Copy link
Contributor

Status

READY

Description

  • Removed the comment from the copiable command
  • Update the title of the command
  • Fixed the command - was missing ending '"'

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 📝 Documentation
  • 🗑️ Chore

@MrSagarShah MrSagarShah requested a review from a team as a code owner January 20, 2024 15:40
@MrSagarShah MrSagarShah changed the title fixed copy format and command docs : fixed copy format and command Jan 22, 2024
@MrSagarShah MrSagarShah changed the title docs : fixed copy format and command docs: fixed copy format and command Jan 22, 2024
@MrSagarShah MrSagarShah reopened this Jan 25, 2024
README.md Outdated
@@ -26,10 +26,10 @@ This template includes a simple demo game with the basics you'll need for game d
dart pub global activate very_good_cli
```

2. Generate your game
2. Generate your game named my_game
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we revert this title change and put the comment back in to describe the name parameter. Let's focus the fix on the missing " which is a good catch.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey, @tomarra Thanks.

The only issue I see here is the quick copy button copies the command with a comment.

Generally, I have seen that description with multiple commands like this.
https://github.com/VeryGoodOpenSource/very_good_cli

For a single command and quick start, we should have the command ready for devs to dive in.

#UX Improvement for devs

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@alestiago alestiago merged commit 3b3fe56 into VeryGoodOpenSource:main Jan 26, 2024
1 check passed
@alestiago alestiago assigned MrSagarShah and unassigned wolfenrain Jan 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants