EvalSharpSite Documentation

This repository hosts the EvalSharpSite documentation website, built with Docusaurus and published via GitHub Pages.

🔗 Live site: https://avironsoftware.github.io/

---

Prerequisites

• Node.js v16 or later
• npm (bundled with Node.js) or Yarn

---

Install Dependencies

Install Docusaurus and other dependencies:

npm install

Build Locally

Generate the static site into the build/ folder:

npm run build

---

Publish to GitHub Pages

Deploy your changes with a single command:

npm run deploy

What happens under the hood:

1. Runs npm run build to produce the build/ output.
2. Commits the contents of build/ into gh-pages branch.
3. Pushes gh-pages to GitHub, from which GitHub Pages serves your site.

---

Adding New Metric Documentation

To document an additional LLM metric, create a Markdown file in the root docs/ folder:

1. Add docs/YourMetric.md

2. Include front-matter at the top:

   ---
   id: YourMetricId
   title: Your Metric Name
   ---
   
   A brief description of what this metric measures and how it’s used.

Docusaurus will automatically add it to the sidebar and generate a page at /docs/YourMetric.