Jack Gerrits b4a2c6e26f
Rewrite and consolidate configuration docs (#1581)
* Rewrite and consolidate configuration docs

* add link to filtering

* updates based on comments

* update lockfile

* update redirect

* spelling mistake

* update the noqa

* update links

* fix broken links

* lint fixes

* address comments

* update wording about model selection

* update cache_seed and json pattern

* add periods

* Update the config json func and other small changes

* update wording of json string

* update intro

* update description of caching

* fix link

* spelling mistake

* fix llm config

* Update website/docs/llm_configuration.ipynb

Co-authored-by: gagb <gagb@users.noreply.github.com>

* Add examples back as notebook

---------

Co-authored-by: gagb <gagb@users.noreply.github.com>
Co-authored-by: Aaron <aaronlaptop12@hotmail.com>
2024-02-11 18:04:43 +00:00
..
2024-01-24 01:18:00 +00:00
2023-08-27 21:30:54 -04:00
2024-01-13 14:54:37 +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: Support for Docusaurus 3.0 in Quarto is from version 1.4. Ensure that your quarto version is 1.4 or higher.

Local Development

Navigate to the website folder and run:

pydoc-markdown
quarto render ./docs
python ./process_notebooks.py
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.