Add CI docs

.changeset/dull-bugs-cry.md

@@ -0,0 +1,5 @@
+---
+"@floe/review-action": minor
+---
+
+Modify diff lookup strategy to support forked braches in PRs.

.changeset/pre.json

@@ -22,6 +22,7 @@
   "changesets": [
     "bright-ducks-help",
     "clean-drinks-laugh",
+    "dull-bugs-cry",
     "dull-buttons-draw",
     "dull-yaks-worry",
     "fast-coins-unite",

.floe/config.json

@@ -6,9 +6,10 @@
   },
   "rulesets": {
     "docs": {
-      "include": ["**/*.md", "**/*.mdx"],
+      "include": ["apps/web/pages/docs/**/*.{md,mdx}"],
       "rules": {
-        "spelling-and-grammar": "warn"
+        "spelling-and-grammar": "warn",
+        "docs-style": "warn"
       }
     }
   }

.floe/rules/docs-style.md

@@ -0,0 +1 @@
+- Don't use "we" or "I"

actions/review-action/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @floe/review-action
 
+## 0.1.0-beta.6
+
+### Minor Changes
+
+- b7e69cc: Modify diff lookup strategy to support forked braches in PRs.
+
 ## 0.1.0-beta.5
 
 ### Minor Changes

actions/review-action/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@floe/review-action",
-  "version": "0.1.0-beta.5",
+  "version": "0.1.0-beta.6",
   "private": true,
   "scripts": {
     "build": "ncc build src/index.ts --out dist --source-map --license licenses.txt",

apps/web/pages/docs/_meta.json

@@ -7,6 +7,7 @@
   "quick-start": "Quick start",
   "usage": "Basic usage",
   "configuration": "Configuration",
+  "ci": "CI",
   "-- API reference": {
     "type": "separator",
     "title": "API reference"

apps/web/pages/docs/ci.mdx

@@ -0,0 +1,53 @@
+import { Callout } from 'nextra/components'
+
+# CI
+
+Using the Floe Reviews GitHub Action is the easiest way to integrate Floe
+Reviews into your CI pipeline. The action will automatically review your pull
+request diffs and leave comments for issues and suggested fixes.
+
+## Usage
+
+Copy the following workflow into the repository's `.github/workflows` directory.
+
+<Callout emoji="💡">Be sure to set `FLOE_API_WORKSPACE` and
+`FLOE_API_SECRET` on the "Actions secrets and variables" page in your GitHub
+settings. `GITHUB_TOKEN` is available by default.</Callout>
+
+```yaml copy filename=".github/workflows/floe-review.yml"
+name: "Floe Review"
+on:
+  pull_request:
+
+jobs:
+  Review:
+    env:
+      FLOE_API_WORKSPACE: ${{ secrets.FLOE_API_WORKSPACE }}
+      FLOE_API_SECRET: ${{ secrets.FLOE_API_SECRET }}
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      # Checkout the Floe repository
+      - name: Checkout Floe
+        uses: actions/checkout@v4
+        with:
+          repository: Floe-dev/floe
+          ref: "@floe/[email protected]"
+          path: ./.github/actions/floe-actions
+
+      # Run the review action
+      - name: Review
+        uses: ./.github/actions/floe-actions/actions/review-action
+```
+
+## Versioning
+
+The Floe Review GitHub Action is versioned using the `ref` attribute and passing
+a git tag. You can find the latest `@floe/review-action`
+[here](https://github.com/Floe-dev/floe/tags).
+
+You can keep Floe up to date with the latest versioning by removing the `ref`,
+but this is not recommended while Floe is in beta.