Skip to content

feat(ai-chat-log): Adding docs for new component #3963

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

Merged
merged 72 commits into from
Jul 1, 2024
Merged

Conversation

krisantrobus
Copy link
Collaborator

Added new docs page for ai-chat-log

<ThumbsDownIcon decorative={false} title="dislike result" />
</Button>
</AIChatMessageActionCard>
<AIChatMessageActionCard>
Copy link
Collaborator

Choose a reason for hiding this comment

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

suggestion: I think I added some aria labels to the rewrite button and maybe also the thumbs up/down buttons in the stories - can you copy whatever I did there for the action card sections in these examples?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Great catch. I will address this in the next commit

}}
language="jsx"
>
{`<AIChatLog>
Copy link
Collaborator

Choose a reason for hiding this comment

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

question (non-blocking): just curious, nothing wrong with it, but why are you writing this example out here and importing the others?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The first LivePreview in the chat-log index page did the same. Seeing a trend for simpler components while looking through other doc pages not being put in examples.

I open to changing this if we want to start a best practice on it

Copy link
Collaborator

Choose a reason for hiding this comment

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

Makes sense, no need to change :)

@@ -292,7 +292,7 @@ This example combines all the separate features displayed previously into one ex

The `useChatLogger` hook provides a hook based approach to managing chat state. It is best used with the `<ChatLogger />` component.

`useChatLogger` returns 3 things:
`useChatLogger` returns 4 things:
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤣 good catch

language="jsx"
noInline
>
{botWithBodyActions}
Copy link
Collaborator

Choose a reason for hiding this comment

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

issue(blocking): these buttons need some padding, can you also go down to just 3 buttons so we're not showing off the wrapping bug until we fix it 😸

image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Absolutely!

Copy link
Collaborator

@nkrantz nkrantz left a comment

Choose a reason for hiding this comment

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

So good!! Can you add a little section to explain the props for ChatMessageAuthor to change the content of the avatar?

Copy link
Contributor

@roxanagomez roxanagomez left a comment

Choose a reason for hiding this comment

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

issue (blocking): move the error codes in the example to the next line.
Screenshot 2024-06-27 at 8 44 29 AM

Co-authored-by: Sarah <sali@twilio.com>
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jul 1, 2024
@serifluous serifluous removed the request for review from roxanagomez July 1, 2024 18:54
@krisantrobus krisantrobus added 🚀 merge it! 🕵🏻‍♀️ Run website visual regression When applied, we will run a full suite of visual regression tests across the doc site and removed Status: Do Not Merge This PR is not yet ready to be merged back into the main branch labels Jul 1, 2024
Copy link

cypress bot commented Jul 1, 2024

Passing run #8153 ↗︎

0 125 0 0 Flakiness 0

Details:

Merge 9e7f85e into b5e6d3f...
Project: Paste Commit: dd67a114f0 ℹ️
Status: Passed Duration: 06:48 💡
Started: Jul 1, 2024 8:00 PM Ended: Jul 1, 2024 8:07 PM

Review all test suite changes for PR #3963 ↗︎

@kodiakhq kodiakhq bot merged commit 5558496 into main Jul 1, 2024
49 of 50 checks passed
@kodiakhq kodiakhq bot deleted the docs/ai-log-2 branch July 1, 2024 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Components Related to the component library (core) of this system Area: Doc Site Related to the documentation website Area: Repo lgtm This PR has been approved by a maintainer 🚀 merge it! 🕵🏻‍♀️ Run website visual regression When applied, we will run a full suite of visual regression tests across the doc site size:XL This PR changes 500-999 lines, ignoring generated files. Type: Documentation Improvements or additions to documentation Type: Tests Adds tests to the code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants