Skip to content

Commit 7ab0d66

Browse files
authored
Tilenk/update rich text docs (#8)
1 parent 181e4be commit 7ab0d66

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/supported_types.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ DevRev supports the following types:
1717
- Rich text is used in DevRev to represent text fields that can be formatted and can contain mentions. Eg.: description of an issue, body of a conversation, etc.
1818
- A simple rich text looks like one markdown string wrapped in an array: `["Hello **world**!"]`.
1919
Markdown should be compatible with [CommonMark Spec v0.30](https://spec.commonmark.org/0.30).
20-
- To support mentions `rich_text` can be formatted as an array of strings and mention objects like so:
20+
- To support mentions `rich_text` can be formatted as an array of strings and mention objects. The field should also use the *use rich text* transformation method.
21+
- Example of a simple mention object:
2122
```json
2223
[
2324
"Hello ",

0 commit comments

Comments
 (0)