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.

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

Update description of programmable_voice.voice7 to provide more info about Ngrok #9

Open
rmkubik opened this issue Jul 7, 2022 · 3 comments

Comments

@rmkubik
Copy link
Contributor

rmkubik commented Jul 7, 2022

This request refers to the description and/or help for the objective programmable_voice.voice7.

The player suggests adding a "hint" section that reminds players how to use Ngrok. This seems like a good idea since ngrok is a pretty odd tool, especially if you're encountering it early in your developer journey.


Source for this request from the TwilioQuest Discord:

Hello~ I did a search and saw there were some older discussions on this, but didn't see mention of this specific point: in the TwilioVoice VR training I think it might be helpful to slightly expand on "you can update your phone number's configuration in the Twilio console to use that ngrok URL for a voice webhook" to include that you need to append something (/voice) after the ngrok url to actually use the endpoint.

In the previous webhook example (Mustache Example), users only need to append the query string to the URL if they use certain fields, and this was clearly noted in the instructions. Obviously, that pointed directly to the bin, but that difference isn't really made clear if you're not familiar with Twilio and/or Node.js configuration. It could totally be due to the fact that this is both my first exposure to the game (and to ngrok as a tool), but I think the natural assumption from a user perspective is that it would again tell you in the instructions, or at least in the QuestIDE comments if you need to add something to the end of the url. Not to imply that I think it needs to be fully written out, though that's one way obviously, but even just a note that says something like "Hint: don't forget to specify blah blah blah" and link to the specific section of the documentation as opposed to the general page? Overall, I suppose it depends on who your target audience really is and how much experience you would expect them to have...anyway, just a thought!

I'm loving everything about the game so far, thanks for your hard work 🙌

@MarvelProgramming
Copy link

MarvelProgramming commented Jul 7, 2022

Where should we position the hint? The first thing that came to mind was making the basic instructions for Ngrok apart of Walkthrough.md for that objective as a baseline

@MarvelProgramming
Copy link

Looking back on this -- I wonder if there's an opportunity here to introduce a new section to the UI. One idea I have is to repurpose the help panel to be a source of transient information (i.e. information that's useful beyond just the objective it's outlined in). It could share the same layout as the settings panel, with the aside being used to categorize different groupings of information. This would more of an attempt to create a general solution, though, which may be more effort than it's worth if this isn't an issue we see a lot or will see a lot as the game continues to grow

@rmkubik
Copy link
Contributor Author

rmkubik commented Oct 6, 2022

I am interested in chatting about this idea more!

On press x to learn, we checked out a game that had like a "glossary" of terms. You could reference these any time, but the game also popped them up in every challenge they were relevant for.

We could consider a system like this as we think about updating the Hack Interface UI/UX

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

No branches or pull requests

2 participants