chore: local doc build instructions

.github/workflows/pre-commit_hooks.yaml

@@ -9,12 +9,12 @@ jobs:
 
     steps:
     - name: checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
-    - name: set up python 3.9
-      uses: actions/setup-python@v1
+    - name: set up python 3.12
+      uses: actions/setup-python@v5
       with:
-        python-version: 3.9
+        python-version: 3.12
 
     - name: install pre-commit
       run: |

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
   rev: 24.2.0
   hooks:
   - id: black
-    language_version: python3.9
+    language_version: python3.12
 
 - repo: local
   hooks:

README.md

@@ -1,6 +1,6 @@
 # splinter (Supabase Postgres LINTER)
 
-<img src="https://github.com/supabase/splinter/assets/12958657/3683c310-c9f6-4b05-ae3a-c51c03d3ff0f" height="250">
+<img src="docs/assets/splinter-elephant.png" height="250">
 
 <p>
 <a href=""><img src="https://img.shields.io/badge/postgresql-15+-blue.svg" alt="PostgreSQL version" height="18"></a>
@@ -57,6 +57,19 @@ git clone https://github.com/supabase/splinter.git
 cd splinter
 ```
 
+### Building the docs locally
+
+The docs use [MkDocs](https://www.mkdocs.org/) with the [Material](https://squidfunk.github.io/mkdocs-material/) theme. To install dependencies and serve the site with live reload:
+
+```sh
+python3 -m venv .venv
+source .venv/bin/activate   # On Windows: .venv\Scripts\activate
+pip install mkdocs-material
+mkdocs serve
+```
+
+Then open http://127.0.0.1:8000. Run `mkdocs build` to output static files to `site/`.
+
 ## Tests
 
 All lints tests with a true positive example.

docs/index.md

@@ -1,5 +1,5 @@
 # Splinter (Supabase Postgres LINTER)
 
-![Image title](https://github.com/supabase/splinter/assets/12958657/3683c310-c9f6-4b05-ae3a-c51c03d3ff0f){ width="300" }
+![Image title](assets/splinter-elephant.png){ width="300" }
 
 This project maintains a set of lints for Supabase projects. It uses SQL queries to identify common database schema issues. Some lints are general purpose for Postgres projects while others are specific to Supabase features, storing their data in Postgres e.g. auth and storage.

mkdocs.yaml

@@ -27,8 +27,8 @@ theme:
     name: 'material'
     features:
       - navigation.expand
-    favicon: 'assets/favicon.ico'
-    logo: 'assets/favicon.ico'
+    favicon: 'assets/favicon.png'
+    logo: 'assets/favicon.png'
     homepage: https://supabase.github.io/splinter
     palette:
         primary: black