Skip to content
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

Add "Customizable System Prompt" part #34

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added src/assets/custom_system_prompt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 37 additions & 1 deletion src/content/docs/features/ai-toolbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,41 @@ To break it down, you need to provide the following information:
Once you finish, save the file, and your custom toolbox command will be available.
When entering the `/help` command, you will see your custom command in the list of available commands.

![Refact Toolbox](../../../assets/custom_command.png)

![Refact Toolbox](../../../assets/custom_command.png)
## Customizable System Prompt

In Refact, a **system prompt** is used to maintain a standard format and clarity in communication. By default, it is set to:

```
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure that you should mention this prompt here, it can be changed
I propose to give an example of default system prompt customization in yaml format as given below

You are a programming assistant. Use backquotes for code blocks, give links to documentation at the end of the response.
```

System prompt is used for **chat** and **toolbox** features.

To personalize your experience, you can add custom system prompts in the `customization.yaml` file:

1. Navigate to the `customization.yaml` file.
2. Add an entry under the `system_prompts` list:
```yaml
my_custom_system_prompt:
description: "My newly created system prompt"
text: "This is the body of my newly created system prompt"
```
3. Replace `my_custom_system_prompt` with a unique identifier for your prompt, and specify the prompt you expect to be used in the `text` field.

Your prompt will be available for selection in the dropdown for the `System Prompt` field in the chat UI.

![Custom System Prompt](../../../assets/custom_system_prompt.png)

### Example of custom system prompt
```
web_dev_prompt:
description: "Prompt for Web Development Queries"
text: "You are an educational assistant specializing in React, Tailwind CSS, and Next.js.
Use backquotes for code snippets and provide context for your questions to get the most accurate assistance."
```

This custom prompt is designed to:
Copy link
Member

Choose a reason for hiding this comment

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

for example, not only web

- Increase specificity: Mentioning specific web technologies (React, Tailwind, Next.js) helps provide more targeted assistance.
- Effective formatting: The mention of backquotes for code snippets instructs how to format the code blocks.
Loading