Files
autogen/website
Alex Reibman 9b92093b00 LLM Observability documentation fixes: Broken links, grammar, and spelling (#2995)
* update markdown hyperlinks to stable urls

* update notebook images and text

* re-write observability section

* Updated section

* update wording

* added newline

* update styling in image tags to be jsx compatible

* added text

* update link

* simplified text

---------

Co-authored-by: Braelyn Boynton <bboynton97@gmail.com>
2024-06-22 03:05:11 +00:00
..
2024-05-14 09:19:43 +00:00
2023-08-27 21:30:54 -04:00
2024-03-28 23:26:22 +00:00
2024-04-05 02:26:06 +00:00
2024-03-14 00:49:39 +00:00
2024-06-10 03:29:34 +00:00

Website

This website is built using Docusaurus 3, a modern static website generator.

Prerequisites

To build and test documentation locally, begin by downloading and installing Node.js, and then installing Yarn. On Windows, you can install via the npm package manager (npm) which comes bundled with Node.js:

npm install --global yarn

Installation

pip install pydoc-markdown pyyaml colored
cd website
yarn install

Install Quarto

quarto is used to render notebooks.

Install it here.

Note: Ensure that your quarto version is 1.5.23 or higher.

Local Development

Navigate to the website folder and run:

pydoc-markdown
python ./process_notebooks.py render
yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.