From c8a0feba4260ee53b27de4d4208e9c805307e67b Mon Sep 17 00:00:00 2001 From: horribleCodes Date: Wed, 22 Feb 2023 12:15:41 +0100 Subject: [PATCH] Added note about syntax highlighting (#1797) Addresses #1761. It's no autodetect, but we're doing our best to make the user aware. --- docs/docs/guides/guidelines.md | 7 ++++++- docs/docs/tasks/reply_as_assistant.md | 7 +++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/docs/guides/guidelines.md b/docs/docs/guides/guidelines.md index b5ca8ee1b9..71b57fc8d0 100644 --- a/docs/docs/guides/guidelines.md +++ b/docs/docs/guides/guidelines.md @@ -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: diff --git a/docs/docs/tasks/reply_as_assistant.md b/docs/docs/tasks/reply_as_assistant.md index d3dd3dc23e..15f0e5b9b2 100644 --- a/docs/docs/tasks/reply_as_assistant.md +++ b/docs/docs/tasks/reply_as_assistant.md @@ -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).