-
Notifications
You must be signed in to change notification settings - Fork 15
Docs/ai chat history #1636
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
Draft
panch1739
wants to merge
4
commits into
main
Choose a base branch
from
docs/ai-chat-history
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Docs/ai chat history #1636
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,86 @@ | ||||||||
| # AI chat history | ||||||||
|
|
||||||||
| The **chat history** displays previous conversations between the user and the AI. | ||||||||
|
|
||||||||
| ## Usage --- | ||||||||
|
|
||||||||
| Chat history helps users maintain context, revisit previous interactions, and continue | ||||||||
| conversations across longer tasks. | ||||||||
|
|
||||||||
| This pattern is a combination of list item and the [side panel](../../components/layout-navigation/side-panel.md). | ||||||||
|
|
||||||||
|  | ||||||||
|
|
||||||||
| ### Best practices | ||||||||
|
|
||||||||
| - Refer to [conversational design](https://ix.siemens.io/docs/guidelines/conversational-design/getting-started) guidelines. | ||||||||
| - Use auto-generated or user-defined titles for chat conversations, | ||||||||
| as they provide a stable reference for each conversation. | ||||||||
| - A preview may replace the title when conversations are short-lived or primarily accessed in recent context. | ||||||||
|
|
||||||||
| ## Design --- | ||||||||
|
|
||||||||
| ### Elements | ||||||||
|
|
||||||||
|  | ||||||||
|
|
||||||||
| > 1\. Title, 2. Metadata (optional), 3. Actions (optional) | ||||||||
|
|
||||||||
| ### Actions | ||||||||
|
|
||||||||
| Actions allow users to manage chat conversations (for example rename, move, archive, delete, or export). | ||||||||
|
|
||||||||
| - If a chat history item has only one action, display it directly and associate it clearly with the item. | ||||||||
| - If there are multiple actions, group them in an overflow menu. | ||||||||
|
|
||||||||
|  | ||||||||
|
|
||||||||
| ### Metadata | ||||||||
|
|
||||||||
| It is typically displayed as text-based informational attributes. | ||||||||
| Icons may be added when they improve recognition. | ||||||||
| [Badges](../../components/status-notifications/badges.md) can be used for explicit | ||||||||
| states or applied labels that should stand out visually. | ||||||||
|
|
||||||||
| Each metadata element can be replaced by a [link](../../components/buttons-menus/links.md), | ||||||||
| styled with `text-secondary`. | ||||||||
|
|
||||||||
|  | ||||||||
|
|
||||||||
| If space remains insufficient due to a high number of metadata elements, consider prioritizing | ||||||||
| the most relevant attributes and progressively removing secondary ones to preserve clarity. | ||||||||
|
Comment on lines
+50
to
+51
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This sentence is 30 words long, which exceeds the 25-word limit recommended by the repository's UX writing guidelines for better readability. Please consider shortening it.
Suggested change
References
|
||||||||
|
|
||||||||
|  | ||||||||
|
|
||||||||
| ### Layouts | ||||||||
|
|
||||||||
| #### Full page layout | ||||||||
|
|
||||||||
| When the AI chat is integrated as a full page layout, | ||||||||
| the chat history is displayed in a collapsible side panel. | ||||||||
|
|
||||||||
|  | ||||||||
|
|
||||||||
| #### Side panel layout | ||||||||
|
|
||||||||
| If AI chat is already handled in a side panel, chat history is accessed within the same panel. | ||||||||
| Selecting a conversation replaces the current chat content inside that panel. | ||||||||
|
|
||||||||
|  | ||||||||
|
|
||||||||
| #### Chat organization | ||||||||
|
|
||||||||
| Conversations may be organized into temporal sections (e.g., Today, Yesterday, Last 7 days, Last 30 days, Older). | ||||||||
|
|
||||||||
| Additional grouping methods can be used when further organization is needed. | ||||||||
|
|
||||||||
| - Use [tabs](../../components/layout-navigation/tabs.md) for broad, mutually exclusive | ||||||||
| categories to help users focus on one category at a time. | ||||||||
| - Use [summary chips](../../components/status-notifications/summary-chip.md) to provide a | ||||||||
| quick overview of grouped conversations | ||||||||
|
|
||||||||
|  | ||||||||
|
|
||||||||
| If additional refinement is needed, consider using filters. | ||||||||
|
|
||||||||
| ## Code --- | ||||||||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.