From 8432670f3f15b12cb1defaef0828d6b7a8621179 Mon Sep 17 00:00:00 2001
From: thedmail <dmail@google.com>
Date: Wed, 22 Jan 2025 14:25:47 -0800
Subject: [PATCH] Docs: Update evaluation.md

Fixes some rendering issues with code blocks and numbered (ordered) lists.
---
 docs/evaluation.md | 89 +++++++++++++++++++++++++++++-----------------
 1 file changed, 56 insertions(+), 33 deletions(-)

diff --git a/docs/evaluation.md b/docs/evaluation.md
index efac99152..6aa601796 100644
--- a/docs/evaluation.md
+++ b/docs/evaluation.md
@@ -41,11 +41,13 @@ This section explains how to perform inference-based evaluation using Genkit.
 ## Quick start
 
 ### Setup
-<ol>
-<li>Use an existing Genkit app or create a new one by following our [Getting
+<ul style="list-style-type:none;">
+<li>1. Use an existing Genkit app or create a new one by following our [Getting
 started](get-started) guide.</li>
-<li>Add the following code to define a simple RAG application to evaluate. For
+<li>2. Add the following code to define a simple RAG application to evaluate. For
 this guide, we use a dummy retriever that always returns the same documents.
+</li>
+</ul>
 
 ```js
 import { genkit, z, Document } from "genkit";
@@ -99,10 +101,12 @@ export const qaFlow = ai.defineFlow({
   }
 );
 ```
-</li>
-<li>(Optional) Add evaluation metrics to your application to use while
+
+<ul style="list-style-type:none;">
+<li>3. (Optional) Add evaluation metrics to your application to use while
 evaluating. This guide uses the `MALICIOUSNESS` metric from the
 `genkitEval` plugin.
+</ul>
 
 ```js
 import { genkitEval, GenkitMetric } from "@genkit-ai/evaluator";
@@ -127,51 +131,66 @@ package.
 ```posix-terminal
   npm install @genkit-ai/evaluator
 ```
-</li>
-<li>Start your Genkit application
+
+<ul style="list-style-type:none;">
+<li>4. Start your Genkit application</li>
+</ul>
 
 ```posix-terminal
 genkit start -- <command to start your app>
 ```
-</li>
-</ol>
 
 ### Create a dataset
 
 Create a dataset to define the examples we want to use for evaluating our flow. 
 
-1. Go to the Dev UI at `http://localhost:4000` and click the **Datasets** button
+<ul style="list-style-type:none;">
+<li>
+1. Go to the Dev UI at <code>http://localhost:4000</code> and click the
+<strong>Datasets</strong> button
 to open the Datasets page.
-
-2. Click on the **Create Dataset** button to open the create dataset dialog.
-
-    a. Provide a `datasetId` for your new dataset. This guide uses
-    `myFactsQaDataset`.
-
-    b. Select `Flow` dataset type.
-
-    c. Leave the validation target field empty and click **Save**
-
+</li>
+<li>
+2. Click on the <strong>Create Dataset</strong> button to open the create dataset dialog.
+  <ul style="list-style-type:none;">
+    <li>a. Provide a <code>datasetId</code> for your new dataset. This guide uses
+    <code>myFactsQaDataset</code>.</li>
+
+    <li>b. Select <code>Flow</code> dataset type.</li>
+
+    <li>c. Leave the validation target field empty and click
+    <strong>Save</strong></li>
+  </ul>
+<li>
 3. Your new dataset page appears, showing an empty dataset. Add examples to it
    by following these steps:
-
-    a. Click the **Add example** button to open the example editor panel.
-
-    b. Only the `input` field is required. Enter `"Who is man's best friend?"`
-    in the `input` field, and click **Save** to add the example has to your
-    dataset.
-
+  <ul style="list-style-type:none;">
+  <li>
+    a. Click the <strong>Add example</strong> button to open the example editor
+    panel.
+  </li>
+  <li>
+    b. Only the <code>input</code> field is required. Enter <code>"Who is man's
+    best friend?"</code>
+    in the <code>input</code> field, and click <strong>Save</strong> to add
+    the example to your dataset.
+  </li>
+  <li>
     c. Repeat steps (a) and (b) a couple more times to add more examples. This
     guide adds the following example inputs to the dataset:
+  </li>
+  </ul>
+</ul>
+
 
-    ```
     "Can I give milk to my cats?"
+
     "From which animals did dogs evolve?"
-    ```
 
+<ul>
     By the end of this step, your dataset should have 3 examples in it, with the
-    values mentioned above.
-
+    values shown above.
+</ul>
 ### Run evaluation and view results
 
 To start evaluating the flow, click the `Evaluations` tab in the Dev UI and
@@ -278,11 +297,15 @@ The `eval:flow` command runs inference-based evaluation on an input dataset.
 This dataset may be provided either as a JSON file or by referencing an existing
 dataset in your Genkit runtime.
 
+To reference an existing dataset:
+
 ```posix-terminal
-# Referencing an existing dataset
 genkit eval:flow qaFlow --input myFactsQaDataset
+```
 
-# or, using a dataset from a file
+To use a dataset from a file:
+
+```posix-terminal
 genkit eval:flow qaFlow --input testInputs.json
 ```