From ea9850b6b2e6e18d527315800eaba31fe36477a5 Mon Sep 17 00:00:00 2001
From: sydney-runkle <sydneymarierunkle@gmail.com>
Date: Wed, 1 May 2024 18:50:02 -0500
Subject: [PATCH] docs updates

---
 .github/workflows/ci.yml | 10 +++++++---
 Makefile                 |  9 +++++++++
 README.md                |  2 ++
 build-docs.sh            |  8 +++++---
 4 files changed, 23 insertions(+), 6 deletions(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index f10a151e..73f4723f 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -45,13 +45,17 @@ jobs:
         with:
           python-version: '3.11'
 
+      # note: PPPR_TOKEN is not available on PRs sourced from forks, but the necessary
+      # dependencies are also listed in docs.txt :)
       - name: install
         run: |
           pip install --upgrade pip
+          pip install --extra-index-url https://pydantic:${PPPR_TOKEN}@pppr.pydantic.dev/simple/ mkdocs-material mkdocstrings-python
           pip install -r requirements/docs.txt
-          pip install --extra-index-url https://pydantic:${PPPR_TOKEN}@pppr.pydantic.dev/simple/ mkdocs-material mkdocstrings-python griffe-typedoc mkdocstrings-typescript
-          npm install
-          npm install -g typedoc
+        # note -- we can use these in the future when mkdocstrings-typescript and griffe-typedoc beocome publicly available
+        # pip install --extra-index-url https://pydantic:${PPPR_TOKEN}@pppr.pydantic.dev/simple/ mkdocs-material mkdocstrings-python griffe-typedoc mkdocstrings-typescript
+        # npm install
+        # npm install -g typedoc
         env:
           PPPR_TOKEN: ${{ secrets.PPPR_TOKEN }}
 
diff --git a/Makefile b/Makefile
index b30c3f3a..c7865705 100644
--- a/Makefile
+++ b/Makefile
@@ -8,6 +8,15 @@ install:
 	pip install -e $(path)
 	pre-commit install
 
+
+.PHONY install-docs
+install-docs:
+	pip install -r requirements/docs.txt
+
+# note -- mkdocstrings-typescript and griffe-typedoc are not yet publicly available
+# but the following can be added above the pip install -r requirements/docs.txt line in the future
+# pip install mkdocstrings-python mkdocstrings-typescript griffe-typedoc
+
 .PHONY: update-lockfiles
 update-lockfiles:
 	@echo "Updating requirements files using pip-compile"
diff --git a/README.md b/README.md
index 5923b746..dbd12d47 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # FastUI
 
+Find the documentation [here](https://docs.pydantic.dev/fastui/).
+
 [![CI](https://github.com/pydantic/FastUI/actions/workflows/ci.yml/badge.svg)](https://github.com/pydantic/FastUI/actions?query=event%3Apush+branch%3Amain+workflow%3ACI)
 [![pypi](https://img.shields.io/pypi/v/fastui.svg)](https://pypi.python.org/pypi/fastui)
 [![versions](https://img.shields.io/pypi/pyversions/fastui.svg)](https://github.com/pydantic/FastUI)
diff --git a/build-docs.sh b/build-docs.sh
index 22f3875a..e32c75ec 100755
--- a/build-docs.sh
+++ b/build-docs.sh
@@ -5,9 +5,11 @@ set -x
 
 python3 -V
 
+python3 -m pip install --extra-index-url https://pydantic:${PPPR_TOKEN}@pppr.pydantic.dev/simple/ mkdocs-material mkdocstrings-python
 python3 -m pip install -r ./requirements/docs.txt
-pip install --extra-index-url https://pydantic:$PPPR_TOKEN@pppr.pydantic.dev/simple/ mkdocs-material mkdocstrings-python griffe-typedoc mkdocstrings-typescript
-npm install
-npm install -g typedoc
+# note -- we can use these in the future when mkdocstrings-typescript and griffe-typedoc beocome publicly available
+# python3 -m pip install --extra-index-url https://pydantic:$PPPR_TOKEN@pppr.pydantic.dev/simple/ mkdocs-material mkdocstrings-python griffe-typedoc mkdocstrings-typescript
+# npm install
+# npm install -g typedoc
 
 python3 -m mkdocs build