Skip to content
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

Jump to bottom

📝 Documentation: Clarify how to operate the Clack prompt #1121

Closed
2 tasks done
johnnyreilly opened this issue Dec 29, 2023 · 8 comments · Fixed by #1122
Closed
2 tasks done

📝 Documentation: Clarify how to operate the Clack prompt #1121

johnnyreilly opened this issue Dec 29, 2023 · 8 comments · Fixed by #1122
Labels
area: documentation Improvements or additions to docs type: feature New enhancement or request

Comments

@johnnyreilly
Copy link
Collaborator

johnnyreilly commented Dec 29, 2023 •
edited
Loading

Bug Report Checklist

Overview

image displaying a screenshot of the terminal with a message I am unclear on

As you can probably gather, I didn't work out how and ended up with everything to my chagrin!

Additional Info

n/a
@johnnyreilly johnnyreilly added the area: documentation Improvements or additions to docs label Dec 29, 2023
@github-actions GitHub Actions
Copy link

Uh oh! @johnnyreilly, the image you shared is missing helpful alt text. Check your issue body.

Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image.

Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.

@JoshuaKGoldberg
Copy link
Owner

Backing context: That prompt UI comes from Clack.
Direct answer: You can press ↑ and ↓ on the keyboard to change the selected item, then space to select.

Screenshot of the Clack prompt from create-typescript-app. A first item (Add all-contributors to track contributions and display them in a README.md table. (--exclude-all-contributors)) is not selected. A second item (Add a GitHub Actions workflow to verify that PRs match an expected format.) is selected.

Was this not clear from the prompt? Do you think there should be some text to explain it?

@JoshuaKGoldberg JoshuaKGoldberg added the status: waiting for author Needs an action taken by the original poster label Dec 29, 2023
@johnnyreilly
Copy link
Collaborator Author

Was this not clear from the prompt? Do you think there should be some text to explain it?

I can only say it wasn't clear to me. It's possible everyone else knows that this is how you do it:

You can press ↑ and ↓ on the keyboard to change the selected item, then space to select.

I'd encourage including the text above

@JoshuaKGoldberg
Copy link
Owner

👍 makes sense, I agree it's not super intuitive as is. Thanks for calling it out! Accepting PRs to add a small indication to the prompt.

@JoshuaKGoldberg JoshuaKGoldberg added type: feature New enhancement or request and removed status: waiting for author Needs an action taken by the original poster labels Dec 29, 2023
@JoshuaKGoldberg JoshuaKGoldberg changed the title 📝 Documentation: How does one remove tooling from the selected list? 📝 Documentation: Clarify how to operate the Clack prompt Dec 29, 2023
@johnnyreilly
Copy link
Collaborator Author

I did try and work out how to add it just now but couldn't work it out. Can you advise where i'd tweak?

@JoshuaKGoldberg
Copy link
Owner

but couldn't work it out

err, what do you mean by this?

@johnnyreilly
Copy link
Collaborator Author

nevermind - found it

johnnyreilly added a commit that referenced this issue Dec 29, 2023
@johnnyreilly
feat: clarify option selection mechanism #1121
8e97616
@johnnyreilly johnnyreilly mentioned this issue Dec 29, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Dec 30, 2023
@johnnyreilly @JoshuaKGoldberg
feat: clarify option selection mechanism (#1122)
aaad5ae 
<!-- 👋 Hi, thanks for sending a PR to create-typescript-app! 💖.
Please fill out all fields below and make sure each item is true and [x]
checked.
Otherwise we may not be able to review your PR. -->

## PR Checklist

- [x] Addresses an existing open issue: fixes #1121
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

<!-- Description of what is changed and how the code change does that.
-->
This PR adds the text `You can press ↑ and ↓ on the keyboard to change
the selected item, then space to select.` to the creation mechanism.

:sunflower:

---------

Co-authored-by: Josh Goldberg ✨ <[email protected]>
@github-actions GitHub Actions
Copy link

🎉 This is included in version v1.51.0 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: documentation Improvements or additions to docs type: feature New enhancement or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: clarify option selection mechanism JoshuaKGoldberg/create-typescript-app
2 participants
@johnnyreilly @JoshuaKGoldberg