Merge pull request #318 from Kiln-AI/main

Update docs fot v0.16

Author: scosman

.cursorrules

@@ -1,9 +1,11 @@
  - call me "boss"
+ - We always use typescript, not javascript
  - Always assume pydantic 2 (not pydantic 1)
  - The project supports Python 3.10 and above
  - When writing tests:
    1) Always use pytest for tests in python code
    2) assume an appriopirate test file already exists, find it, and suggest tests get appended to that file. If no such file exists, ask me before assuming a new test file is the correct route.
    3) Test brevity is important. Use approaches for re-use and brevity including using fixtures for repeated code, and using pytest parameterize for similar tests
+   4) After writing a new test, run it and ensure it works. Fix any issues you find.
 
 

.github/workflows/build_and_test.yml

@@ -5,6 +5,7 @@ on:
 
 jobs:
   build:
+    name: Build, Typecheck, and Test Python
     runs-on: ubuntu-latest
     strategy:
       matrix:

.github/workflows/build_desktop.yml

@@ -5,6 +5,7 @@ on:
 
 jobs:
   build:
+    name: Build Desktop Apps
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false

.github/workflows/build_docs.yml

@@ -13,6 +13,7 @@ permissions:
 
 jobs:
   build:
+    name: Build Docs
     runs-on: ubuntu-latest
 
     steps:

.github/workflows/format_and_lint.yml

@@ -12,6 +12,7 @@ on:
 
 jobs:
   format_and_lint:
+    name: Format and Lint Python
     runs-on: ubuntu-latest
 
     steps:

.github/workflows/test_count.yml

@@ -7,6 +7,7 @@ on:
 
 jobs:
   count_tests:
+    name: Count Tests
     runs-on: ubuntu-latest
 
     steps:

.github/workflows/web_format_lint_build.yml

@@ -4,7 +4,7 @@ on: [push, pull_request]
 
 jobs:
   webui_checks:
-    name: Code Format, Lint, Typecheck, Test, and Build
+    name: Web UI Code Format, Lint, Typecheck, Test, and Build
     runs-on: ubuntu-latest
     defaults:
       run:

CONTRIBUTING.md

@@ -56,3 +56,27 @@ To confirm everything works locally, run:
 ```bash
 ./checks.sh
 ```
+
+## Optional Setup
+
+### IDE Extensions
+
+We suggest the following extensions for VSCode/Cursor. With them, you'll get compliant formatting and linting in your IDE.
+
+- Prettier
+- Pylance
+- Python
+- Python Debugger
+- Ruff
+- Svelte for VS Code
+- Vitest
+- ESLint
+- Cursor Pyright
+
+### llms.txt
+
+Vibing? Here are some [llms.txt](https://llmstxt.org) you may want to add.
+
+Usage: `@docs Svelte` in cursor lets the LLM read the docs of the specified library. Most popular libraries added by Cursor automatically, but here are some to add manually:
+
+- daisyUI’s: https://daisyui.com/docs/editor/cursor/

README.md

@@ -1,7 +1,9 @@
 <p align="center">
-    <picture>
-        <img width="205" alt="Kiln AI Logo" src="https://github.com/user-attachments/assets/5fbcbdf7-1feb-45c9-bd73-99a46dd0a47f">
-    </picture>
+    <a href="https://getkiln.ai">
+        <picture>
+            <img width="205" alt="Kiln AI Logo" src="https://github.com/user-attachments/assets/5fbcbdf7-1feb-45c9-bd73-99a46dd0a47f">
+        </picture>
+    </a>
 </p>
 <h3 align="center">
     Rapid AI Prototyping and Dataset Collaboration Tool

app/desktop/WinInnoSetup.iss

@@ -3,7 +3,7 @@
 
 #define MyAppPath "build\dist\Kiln"
 #define MyAppName "Kiln"
-#define MyAppVersion "0.15.0"
+#define MyAppVersion "0.16.0"
 #define MyAppPublisher "Chesterfield Laboratories Inc"
 #define MyAppURL "https://getkiln.ai"
 #define MyAppExeName "Kiln.exe"