docs(InlineAiPrompt): add inline ai prompt documentation #3174
Conversation
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
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi reviewed Aug 12, 2025
dimodi approved these changes Aug 12, 2025
| --- | ||
| title: Overview | ||
| page_title: InlineAIPrompt Overview | ||
| description: Overview of the InlineAIPrompt for Blazor. |
There was a problem hiding this comment.
Add a meaningful description. Use Copilot if needed. See seehttps://progresssoftware.atlassian.net/wiki/spaces/DTS/pages/1884586115/How+to+write+meta+descriptions+for+docs+using+Copilot for tips.
| | ||
| 1. Add the `<TelerikInlineAIPrompt>` tag. | ||
| 2. Subscribe to the `OnPromptRequest` event that will fire whenever the user sends a prompt request. The handler expects an argument of type `InlineAIPromptPromptRequestEventArgs`. | ||
| 3. Set the `Prompt` parameter |
There was a problem hiding this comment.
Add a full stop at the end of the sentence.
| 1. Add the `<TelerikInlineAIPrompt>` tag. | ||
| 2. Subscribe to the `OnPromptRequest` event that will fire whenever the user sends a prompt request. The handler expects an argument of type `InlineAIPromptPromptRequestEventArgs`. | ||
| 3. Set the `Prompt` parameter | ||
| 4. (optional) Set the `PromptContext` parameter |
There was a problem hiding this comment.
Add a full stop at the end of the sentence.
| | ||
| | Parameter | Type and Default Value | Description | | ||
| | --- | --- | --- | | ||
| | `Class` | `string` | `The class that is rendered on the .k-prompt element.` | |
There was a problem hiding this comment.
Remove the monospace style from the last column. Use this style only when referring to elements of the programming code. The descriptions must use the default text style, not monospace (inline code).
| --- | ||
| title: Streaming | ||
| page_title: InlineAIPrompt Streaming | ||
| description: Streaming in the InlineAIPrompt for Blazor. |
There was a problem hiding this comment.
Add a meaningful description.
| --- | ||
| title: Events | ||
| page_title: InlineAIPrompt - Events | ||
| description: Events in the InlineAIPrompt for Blazor. |
There was a problem hiding this comment.
Add a meaningful description.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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.
Closes: https://github.com/telerik/blazor/issues/11688