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

add dedicated feedback page #8900

Merged
merged 4 commits into from
Feb 10, 2025
Merged

Conversation

zzhaobraze
Copy link
Collaborator

Add a dedicated feedback page
/docs/feedback/

image

@josh-mccrowell-braze
Copy link
Collaborator

Thanks for this, Z! Going to shop around for feedback.

</div>
<div style="margin-top: 15px;">
<b>Share your feedback</b> <br />
<textarea id="feedback_comment" placeholder="I couldn’t find any information about this error message"></textarea><br />
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<textarea id="feedback_comment" placeholder="I couldn’t find any information about this error message"></textarea><br />
<textarea id="feedback_comment" placeholder=""I couldn’t find any information about this error message""></textarea><br />

Is it possible to add quotation marks so that the placeholder text looks more like an example?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

try now once the vercel update

@bre-fitzgerald
Copy link
Collaborator

Hey @zzhaobraze! This looks great, thanks so much for putting this together! One big thing—the first field "How useful do you find Braze docs?" is an h3, but this should be a label similar to the "Share your feedback" field.

image

In that same vein, I have a few concerns about the accessibility of this form with the current implementation.

  • The gray unhighlighted version of the stars looks very light. Can we explore other options for accessibility? Previously I think it filled in and bolded the outline of the star. That would be preferred. Right now we are only denoting selection through color, which is not accessible.
  • The form elements (the rating stars and textarea) lack proper semantic grouping with <form> and associated <fieldset>/<legend> for better structure and clarity.
  • Interactive elements like the rating stars should be implemented with proper semantics like <button> or <input type="radio">, rather than styled <li> elements for better screen reader support and keyboard navigation.

Is this something we can incorporate into the revision? I want to make sure we're putting out a form that everyone can interact with! 💪 Let me know how I can support.

@zzhaobraze
Copy link
Collaborator Author

Hey @zzhaobraze! This looks great, thanks so much for putting this together! One big thing—the first field "How useful do you find Braze docs?" is an h3, but this should be a label similar to the "Share your feedback" field.

image

In that same vein, I have a few concerns about the accessibility of this form with the current implementation.

  • The gray unhighlighted version of the stars looks very light. Can we explore other options for accessibility? Previously I think it filled in and bolded the outline of the star. That would be preferred. Right now we are only denoting selection through color, which is not accessible.
  • The form elements (the rating stars and textarea) lack proper semantic grouping with <form> and associated <fieldset>/<legend> for better structure and clarity.
  • Interactive elements like the rating stars should be implemented with proper semantics like <button> or <input type="radio">, rather than styled <li> elements for better screen reader support and keyboard navigation.

Is this something we can incorporate into the revision? I want to make sure we're putting out a form that everyone can interact with! 💪 Let me know how I can support.

I have made some ui changes but changing it stars to button or input would require a complete rework of the stars.

@josh-mccrowell-braze
Copy link
Collaborator

Hey Z! The rework is great, appreciate the extra fixes. I just chatted with @bre-fitzgerald, and we agree that it's worth the extra time to make sure this is fully accessible.

I understand this wasn't in the initial request. What's the best way to proceed?

One thing we could do is:

  • Merge this PR (so the ticket doesn't get stale
  • Open another GE ticket to make the stars selectable using the keyboard
  • Hold off on "launching" this feature until the new GE ticket is worked, so the page is more ADA compliant at launch.

Let me know your thoughts. Thanks!

@zzhaobraze
Copy link
Collaborator Author

Hey Z! The rework is great, appreciate the extra fixes. I just chatted with @bre-fitzgerald, and we agree that it's worth the extra time to make sure this is fully accessible.

I understand this wasn't in the initial request. What's the best way to proceed?

One thing we could do is:

  • Merge this PR (so the ticket doesn't get stale
  • Open another GE ticket to make the stars selectable using the keyboard
  • Hold off on "launching" this feature until the new GE ticket is worked, so the page is more ADA compliant at launch.

Let me know your thoughts. Thanks!

i would just merge this PR if everything is fine and convert the stars as a todo

@josh-mccrowell-braze
Copy link
Collaborator

Cool, I'll merge. Do you want me to open a new ticket for the star conversion?

@josh-mccrowell-braze josh-mccrowell-braze merged commit 2c95203 into develop Feb 10, 2025
6 checks passed
@josh-mccrowell-braze josh-mccrowell-braze deleted the dedicated-feedback branch February 10, 2025 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants