Sample Text RFC

[jhanvi1399]

Hi everyone! 👋🏼

Paste is adding a new component — Sample Text and we'd like your feedback! Please leave your feedback/thoughts by Tuesday, November 05, 2024.

A Sample Text distinguishes examples from the rest of the text and clarifies what kind of input is expected into the system. It will look like:

Spec

Here is the Sample Text Spec. Please give this a read and share your thoughts/feedback/questions as comments

Design

Here is the Figma design exploration for Sample Text and share your design related questions or feedback.

Open Questions

• Is there any use case we might have missed?
• Is is easy enough to visually differentiate the Sample Text from the Usual Text?
• Does the spec convey when and where should Sample Text be used?

[TwilioPasteBot]

Disclaimer: This is a very experimental bot using OpenAI's GPT-4. The answers may not be correct, a human will review the answer and update it if necessary.

---

Sorry, I don't know how to help with that.

I did do a search though, and I managed to find these other Discussions that might be similar or related to your question. Give them a read to see if they answer your question. If they do, head back here and update this discussion and mark it as answered, pointing others to the related discussion:

• Keyboard Key RFC (updated: 10/17/2024, similarity score: 88%)
• Number Input - Design and Spec RFC (updated: 08/18/2023, similarity score: 87%)
• Spec for Detail Text (updated: 10/21/2023, similarity score: 87%)

[dpazc]

Hi! Thanks for the work with this component I have some comments for your questions:

- Is there any use case we might have missed?
In the Custom Prompt Operator project, tables are used for configuring operators. During feedback interviews, many customers recommended adding examples directly in the text inputs within the table, as this would make it easier for them to understand how to complete each section.

Because users can add multiple rows to the table, adding help text for each input field could create visual clutter. Instead, a single example component for the entire table would provide a concise reference without overwhelming users.

For instance, in the "Entities" table, each entity consists of two fields—type and description—which together define a single entity. Clear examples for both fields would help explain what a complete entity should look like.

From my POV The list approach you are proposing wouldn't effectively separate the examples for the type and description fields, which can make it unclear that they form a single entity example. A descriptive list format might improve this by visually grouping these elements as a single example of an entity, similar to the mockup below:

For your reference this is how this was solved before: