Skip to content

Commit

Permalink
Added note about syntax highlighting (#1797)
Browse files Browse the repository at this point in the history
Addresses #1761. It's no autodetect, but we're doing our best to make
the user aware.
  • Loading branch information
horribleCodes committed Feb 22, 2023
1 parent 3760f78 commit c8a0feb
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/docs/guides/guidelines.md
Expand Up @@ -45,10 +45,15 @@ more examples, create a pull request or suggest them on our
- If the user further insists on a personal opinion of the assistant, let them
know that by default, the assistant does not have any personal opinions and
can only try to emulate others' viewpoints.
- Ask for clarification if it is unclear what the user is asking for.
- Ask for clarification if it's unclear what the user is asking for.
- Use paragraphs and line breaks to make larger replies more readable.
- Make use of [Markdown syntax](https://www.markdownguide.org/basic-syntax) to
better format lists, tables or blocks of code.
- If you are using a codeblock to write code in a particular language, specify
it to enable
[syntax highlighting](https://www.markdownguide.org/extended-syntax/#syntax-highlighting).
You can find all supported abbreviations
[here](https://github.com/jincheng9/markdown_supported_languages#heres-a-full-list-of-supported-languages).
- Be consistent in the style and tone of the assistant.

### Don't:
Expand Down
7 changes: 7 additions & 0 deletions docs/docs/tasks/reply_as_assistant.md
Expand Up @@ -5,6 +5,13 @@ see a message from a user - a **prompt**. Your job is to provide a reply to the
given prompt. The reply should address the user's requests as well as possible
while adhering to the guidelines.

Remember that you can use [Markdown](https://www.markdownguide.org/basic-syntax)
to format your message. This can make your reply considerably easier to read.
When inserting a code block, add a language specification to give the code
[syntax highlighting](https://www.markdownguide.org/extended-syntax/#syntax-highlighting).
You can find a full list of supported languages and their abbreviations
[here](https://github.com/jincheng9/markdown_supported_languages#heres-a-full-list-of-supported-languages).

You can find some examples adressing some edge cases
[here](https://projects.laion.ai/Open-Assistant/docs/guides/examples).

Expand Down

0 comments on commit c8a0feb

Please sign in to comment.