diff --git a/.github/workflows/pre-commit_hooks.yaml b/.github/workflows/pre-commit_hooks.yaml index 163721c..268655e 100644 --- a/.github/workflows/pre-commit_hooks.yaml +++ b/.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: | diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f31c9db..56b7683 100644 --- a/.pre-commit-config.yaml +++ b/.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: diff --git a/README.md b/README.md index 55a6625..1af5c5c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # splinter (Supabase Postgres LINTER) - +

PostgreSQL version @@ -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. diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico index d3fca2a..49c20b9 100644 Binary files a/docs/assets/favicon.ico and b/docs/assets/favicon.ico differ diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png new file mode 100644 index 0000000..456f3c7 Binary files /dev/null and b/docs/assets/favicon.png differ diff --git a/docs/assets/splinter-elephant.png b/docs/assets/splinter-elephant.png new file mode 100644 index 0000000..ca604b7 Binary files /dev/null and b/docs/assets/splinter-elephant.png differ diff --git a/docs/index.md b/docs/index.md index 0c33608..2601330 100644 --- a/docs/index.md +++ b/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. diff --git a/mkdocs.yaml b/mkdocs.yaml index bb8ae7c..a60f2ba 100644 --- a/mkdocs.yaml +++ b/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