ReviewOS

also looking at this

stacks/buddy

docs: replace the claims the source does not support

#1400
Merged glennmichael123 wants to merge docs/correct-unsupported-claims into main
32 files +1660 -1772
CLAUDE.mdmodified+12-12
Changes to CLAUDE.md
@@ -955,17 +955,17 @@ Choose from several carefully crafted presets with smart recommendations:
955955
956956#### 📝 Step 7: Enhanced Configuration Generation
957957
958- Creates `buddy.config.json` with repository-specific settings
958- Creates `buddy.config.ts` with repository-specific settings
959959- **Project-aware defaults** - Configuration optimized for detected project type
960960- **Ecosystem integration** - Includes detected package managers and dependency files
961961- Includes sensible defaults and customization options
962962
963963**�� Step 8: Workflow Generation & Validation**
964964
965- Generates three core GitHub Actions workflows:
966 - `buddy-dashboard.yml` - Dependency Dashboard Management
967 - `buddy-check.yml` - Auto-rebase PR checker
968 - `buddy-update.yml` - Scheduled dependency updates
965- Generates two GitHub Actions workflows:
966 - `buddy.yml` - Unified workflow: rebase checks, scheduled updates and the dashboard
967 - `buddy-security.yml` - Security audit, kept separate so it triggers on its own path filters
968- Removes the stale `buddy-check.yml`, `buddy-update.yml`, `buddy-dashboard.yml` and `gh-audit.yml` if an earlier version left them behind
969969- **YAML validation** - Ensures generated workflows are syntactically correct
970970- **Security best practices** - Validates token usage and permissions
971971- **Workflow testing** - Verifies generated workflows meet requirements
@@ -1018,7 +1018,7 @@ buddy update-check --dry-run
10181018buddy update-check --verbose
10191019
10201020# Get help
1021buddy help
1021buddy --help
10221022```
10231023
10241024### Configuration
@@ -1281,7 +1281,7 @@ All Buddy pull requests include a rebase checkbox at the bottom:
12811281### Using the Rebase Feature
12821282
128312831. **Check the box**: In any Buddy PR, check the rebase checkbox
12842. **Automatic detection**: The rebase workflow runs every minute to detect checked boxes
12842. **Automatic detection**: Editing the PR body fires the workflow, which detects the checked box
128512853. **Updates applied**: The PR is automatically updated with the latest dependency versions
128612864. **Checkbox unchecked**: After successful rebase, the checkbox is automatically unchecked
12871287
@@ -1302,9 +1302,9 @@ buddy update-check --verbose
13021302
13031303### Automated Rebase Workflow
13041304
1305Buddy includes a pre-built GitHub Actions workflow (`.github/workflows/buddy-check.yml`) that:
1305Buddy includes a pre-built GitHub Actions workflow (`.github/workflows/buddy.yml`) that:
13061306
1307- **�� Runs every minute**: Automatically checks for rebase requests
1307- **�� Event-driven**: Triggers on `pull_request: [edited]` and `issues: [edited]`, so ticking a checkbox runs it immediately — no polling
13081308- **�� Scans all PRs**: Finds Buddy PRs with checked rebase boxes
13091309- **�� Updates dependencies**: Re-scans for latest versions and updates files
13101310- **�� Updates PR content**: Refreshes PR title, body, and file changes
@@ -1346,9 +1346,9 @@ buddy dashboard --title "My Dependencies"
13461346
13471347### Automated Dashboard Updates
13481348
1349Buddy includes a pre-built GitHub workflow (`.github/workflows/buddy-dashboard.yml`) that automatically updates your dependency dashboard:
1349Buddy includes a pre-built GitHub workflow (`.github/workflows/buddy.yml`) that automatically updates your dependency dashboard:
13501350
1351- **�� Scheduled**: Runs Monday, Wednesday, Friday at 9 AM UTC
1351- **�� Scheduled**: Every 2 hours, 15 minutes after the dependency update run (cron `15 */2 * * *`)
13521352- **��️ Manual**: Trigger from Actions tab with custom options
13531353- **�� Auto-Pin**: Keeps dashboard pinned by default
13541354- **�� Dry-Run**: Preview mode available
@@ -1423,7 +1423,7 @@ Buddy automatically detects and updates the following dependency file formats:
14231423- **.github/workflows/*.yml** - GitHub Actions workflow files
14241424- **.github/workflows/*.yaml** - Alternative YAML extension
14251425
1426All dependency files are parsed using the `ts-pkgx` library to ensure compatibility with the pkgx registry ecosystem while maintaining support for tools like Launchpad that reuse the same registry format. GitHub Actions are detected by parsing `uses:` statements in workflow files and checking for updates via the GitHub releases API.
1426All dependency files are parsed using the `ts-pantry` library to ensure compatibility with the pkgx registry ecosystem while maintaining support for tools like Launchpad that reuse the same registry format. GitHub Actions are detected by parsing `uses:` statements in workflow files and checking for updates via the GitHub releases API.
14271427
14281428### Pull Request Format
14291429