Skip to content

docs(InlineAiPrompt): add inline ai prompt documentation #3174

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 2 commits into from
Aug 12, 2025

Conversation

xristianstefanov
Copy link
Contributor

@xristianstefanov xristianstefanov self-assigned this Aug 12, 2025
@xristianstefanov xristianstefanov requested review from a team as code owners August 12, 2025 09:53
@dimodi dimodi merged commit 06ccb07 into master Aug 12, 2025
@github-actions github-actions bot deleted the docs-inlineaiprompt branch August 12, 2025 12:23
---
title: Overview
page_title: InlineAIPrompt Overview
description: Overview of the InlineAIPrompt for Blazor.
Copy link
Contributor

Choose a reason for hiding this comment

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

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
Copy link
Contributor

Choose a reason for hiding this comment

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

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
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a full stop at the end of the sentence.


| Parameter | Type and Default&nbsp;Value | Description |
| --- | --- | --- |
| `Class` | `string` | `The class that is rendered on the .k-prompt element.` |
Copy link
Contributor

Choose a reason for hiding this comment

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

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a meaningful description.

---
title: Events
page_title: InlineAIPrompt - Events
description: Events in the InlineAIPrompt for Blazor.
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a meaningful description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants