Merge pull request #175 from argos-ci/greg/arg-219-update-docs-for-skip

Update docs for skip

Author: gregberge

docs/guides/skip-build.mdx

@@ -1,45 +1,52 @@
 # Skipping a Build
 
-In some cases, you may want to skip Argos checks for a commit or pull request.  
-This is especially useful when Argos is configured as a **required status check** in GitHub, but screenshots are not needed (e.g. documentation-only changes, emergency hotfixes). Running Argos in these situations would be unnecessary and could even block your workflow.
+Sometimes you want Argos to report success without running visual tests.  
+This is useful when Argos is configured as a required GitHub status check, but you intentionally want to skip screenshots for a commit or pull request.
 
-To address this, you can use the `skipped` option.  
-When `skipped: true` is set, **no screenshots are uploaded** and the commit status is immediately marked as **success**.
+A skipped build:
 
-## When to use `skipped`
+- uploads no screenshots
+- runs no visual comparison
+- immediately marks the commit status as success
 
-- Documentation changes with no impact on the UI
-- Hotfixes where visual testing is not relevant
-- Branches or pull requests that don’t require screenshots
-- Scheduled builds you want to disable selectively
+## Creating a skipped build
 
-:::warning
+You can skip a build in two ways.
 
-Skipping should only be used in exceptional cases. It is not meant to replace regular visual testing.
+### Environment variable
 
-:::
+Set the environment variable `ARGOS_SKIPPED` to `"true"` in your CI configuration.
 
-## How to enable skipping
+**GitHub Actions example:**
 
-You can enable skipping in two ways:
+```yaml title=".github/workflows/ci.yml"
+jobs:
+  visual-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+      - name: Run tests
+        run: npm run visual-tests # or your test command
+        env:
+          ARGOS_SKIPPED: "true"
+```
 
-1. **Environment variable**  
-   Set `ARGOS_SKIPPED` to `"true"` in your CI configuration.
+This reports a successful Argos check without uploading screenshots.
 
-2. **Configuration option**  
-   Add `skipped: true` in your Argos SDK configuration.
+### Using the CLI
 
-## GitHub Actions example
+You can also explicitly create a skipped build using the CLI.
 
-```yaml title="ci.yml"
+```yaml title=".github/workflows/ci.yml"
 jobs:
   visual-tests:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
-      - name: Run tests
-        run: npm run visual-tests # or your test command
-        env:
-          ARGOS_SKIPPED: "true" # Marks Argos check as "success" without uploading screenshots
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+      - name: Skip Argos build
+        run: npx @argos-ci/cli skip
 ```
+
+This immediately creates a successful Argos build with no visual testing.