remove <br>s which break fern docs (#2759)

This commit is contained in:
Shuchang Zheng
2025-06-21 04:35:35 +08:00
committed by GitHub
parent ae9f288ebf
commit 5bd2cabae4

View File

@@ -35,15 +35,13 @@ slug: getting-started/prompting-guide
- **Use clear visual indicators and phrases to capture the main goal and completion criteria.**
- For instance, if your goal is to navigate to a certain page, you can say “using the sales dropdown at the top of the page” or “to navigate to invoices, the button has a receipt icon”
### Donts
### Don'ts
- **Be unclear.** Make sure your goals are clear, that details are rooted in visuals. If youre confused or a random person would be confused, the LLM will definitely be confused
- **Provide too little information.** If youre logging in, you need to provide login credentials, a URL to go to, etc. Think, “what would I need if I were starting this task from scratch?” You can always overprovide information and Skyvern will use what it needs
- **Make an action list unless absolutely necessary.** If needed as extra details, make sure its accompanied by a main goal
- **Name the HTML element for items.** Some HTML element items are accessible, but not all. Wouldnt recommend this as a first course of action!
<br>
### Examples
**Example Navigation/Task Block prompt:**
@@ -67,8 +65,6 @@ Now that you have the location, your goal is to go to google maps and extract th
Click the continue button
<br>
# Workflow Troubleshooting Guide
## Process
@@ -80,8 +76,6 @@ There are a two main reasons why a workflow might fail
- prompt issues/configuration issues
- bugs
<br>
## When you get a Failure or Termination
### When you need to make a prompt change
@@ -113,8 +107,6 @@ What do you do when youre unsure:
- Issues with common bugs like dropdowns, like checkboxes, etc.
- Action lists referencing the wrong element or bounding boxes not mapped on properly
<br>
## When you get a Complete
### If it aint broke dont fix it…