Update voice-formatting-plan.mdx

Author: sahilsuman933

fern/assistants/voice-formatting-plan.mdx

@@ -20,132 +20,21 @@ You can turn off formatting if you want the TTS to read the raw LLM output.
 
 When enabled, the formatter runs a series of transformations on your text, each handled by a specific function. Here's the order and what each function does:
 
-<Steps>
-
-  <Step title="removeAngleBracketContent">
-    Removes anything in `<...>`, except for `<break>`, `<spell>`, or double angle brackets `<< >>`.
-
-    **Example:**
-    ```
-    Hello <tag> world
-    **Wanted** to say *hi*
-    ...
-    ```
-    Becomes:
-    ```
-    Hello  world
-    **Wanted** to say *hi*
-    ...
-    ```
-  </Step>
-
-  <Step title="removeMarkdownSymbols">
-    Removes markdown characters like `_`, `` ` ``, and `~`. Some versions also remove double asterisks, but that might happen in the next step.
-
-    **Example:**
-    ```
-    **Wanted** to say *hi*
-    ```
-    If only `_`, backticks, and tildes are removed, asterisks remain for now.
-  </Step>
-
-  <Step title="removePhrasesInAsterisks">
-    Removes text wrapped in single or double asterisks.
-
-    **Example:**
-    ```
-    **Wanted** to say *hi*
-    ```
-    Becomes:
-    ```
-     to say
-    ```
-  </Step>
-
-  <Step title="replaceNewLinesWithPeriods">
-    Converts line breaks to periods for smoother speech.
-
-    **Example:**
-    ```
-    Hello  world\n to say\nWe have NASA and .NET here,\ncall me at 123-456-7890,\nprice: $42.50\nand the date is 2023 05 10\nand time is 14:00\nDistance is 5km\nWe might see 9999\nthe address is 320 ST 21 RD\nmy email is JOHN.DOE@example.COM
-    ```
-    Becomes:
-    ```
-    Hello  world .  to say . We have NASA and .NET here, call me at 123-456-7890, price: $42.50 and the date is 2023 05 10 and time is 14:00 Distance is 5km We might see 9999 the address is 320 ST 21 RD my email is JOHN.DOE@example.COM
-    ```
-  </Step>
-
-  <Step title="replaceColonsWithPeriods">
-    Replaces `:` with `.` for better phrasing.
-
-    **Example:**
-    ```
-    price: $42.50
-    ```
-    Becomes:
-    ```
-    price. $42.50
-    ```
-  </Step>
-
-  <Step title="formatAcronyms">
-    Converts known acronyms to lowercase or spaces out unknown all-caps words. If it's all-caps but not recognized, it might get spaced letters. If it has vowels, it's left alone.
-
-    **Example:**
-    - `NASA` → `nasa`
-    - `.NET` → `.net`
-  </Step>
-
-  <Step title="formatDollarAmounts">
-    Expands currency to words.
-
-    **Example:**
-    - `$42.50` → "forty two dollars and fifty cents"
-  </Step>
-
-  <Step title="formatEmails">
-    Replaces `@` with "at" and `.` with "dot" in email addresses.
-
-    **Example:**
-    - `JOHN.DOE@example.COM` → `JOHN dot DOE at example dot COM`
-  </Step>
-
-  <Step title="formatDates">
-    Converts date strings to spoken dates.
-
-    **Example:**
-    - `2023 05 10` → "Wednesday, May 10, 2023"
-  </Step>
-
-  <Step title="formatTimes">
-    Expands time strings for clarity.
-
-    **Example:**
-    - `14:00` → `14`
-  </Step>
-
-  <Step title="formatDistances, formatUnits, formatPercentages, formatPhoneNumbers">
-    - `5km` → "5 kilometers"
-    - `43 lb` → "forty three pounds"
-    - `50%` → "50 percent"
-    - `123-456-7890` → "1 2 3 4 5 6 7 8 9 0"
-  </Step>
-
-  <Step title="formatNumbers">
-    - Years below the current year are read as digits (e.g., `2023`)
-    - Large numbers above a cutoff are read as digits
-    - Negative numbers: `-9` → "minus nine"
-    - Decimals: `2.5` → "two point five"
-  </Step>
-
-  <Step title="Applying Replacements">
-    Runs user-defined replacements last, such as expanding street abbreviations.
-
-    **Example:**
-    - `320 ST 21 RD` → `320 STREET 21 ROAD`
-  </Step>
-
-</Steps>
+| **Step** | **Function Name** | **Description** | **Before** | **After** |
+| :------- | :---------------- | :-------------- | :--------- | :-------- |
+| 1 | `removeAngleBracketContent` | Removes anything within `<...>`, except for `<break>`, `<spell>`, or double angle brackets `<< >>`. | `Hello <tag> world` | `Hello  world` |
+| 2 | `removeMarkdownSymbols` | Removes markdown symbols like `_`, `` ` ``, and `~`. Asterisks (`*`) are preserved in this step. | `**Wanted** to say *hi*` | `**Wanted** to say *hi*` |
+| 3 | `removePhrasesInAsterisks` | Removes text surrounded by single or double asterisks. | `**Wanted** to say *hi*` | ` to say` |
+| 4 | `replaceNewLinesWithPeriods` | Converts new lines (`\n`) to periods for smoother speech. | `Hello  world\n to say\nWe have NASA` | `Hello  world .  to say . We have NASA` |
+| 5 | `replaceColonsWithPeriods` | Replaces `:` with `.` for better phrasing. | `price: $42.50` | `price. $42.50` |
+| 6 | `formatAcronyms` | Converts known acronyms to lowercase (e.g., NASA → nasa) or spaces out unknown all-caps words unless they contain vowels. | `NASA and .NET` | `nasa and .net` |
+| 7 | `formatDollarAmounts` | Converts currency amounts to spoken words. | `$42.50` | `forty two dollars and fifty cents` |
+| 8 | `formatEmails` | Replaces `@` with "at" and `.` with "dot" in emails. | `JOHN.DOE@example.COM` | `JOHN dot DOE at example dot COM` |
+| 9 | `formatDates` | Converts date strings into spoken date format. | `2023 05 10` | `Wednesday, May 10, 2023` |
+| 10 | `formatTimes` | Expands or simplifies time expressions. | `14:00` | `14` |
+| 11 | `formatDistances`, `formatUnits`, `formatPercentages`, `formatPhoneNumbers` | Converts units, distances, percentages, and phone numbers into spoken words. | `5km`, `43 lb`, `50%`, `123-456-7890` | `5 kilometers`, `forty three pounds`, `50 percent`, `1 2 3 4 5 6 7 8 9 0` |
+| 12 | `formatNumbers` | Formats general numbers: years read as digits, large numbers spelled out, negative and decimal numbers clarified. | `-9`, `2.5`, `2023` | `minus nine`, `two point five`, `2023` |
+| 13 | `Applying Replacements` | Applies user-defined final replacements like expanding street abbreviations. | `320 ST 21 RD` | `320 STREET 21 ROAD` |
 
 ---