Skip to content

Fix incorrect documentation in markdown files#92

Open
JoshSalway wants to merge 2 commits intolaravel:mainfrom
JoshSalway:fix/incorrect-docs
Open

Fix incorrect documentation in markdown files#92
JoshSalway wants to merge 2 commits intolaravel:mainfrom
JoshSalway:fix/incorrect-docs

Conversation

@JoshSalway
Copy link

@JoshSalway JoshSalway commented Mar 16, 2026

Summary

Fixes incorrect documentation and adds missing commands to README.

Closes #91

Changes

AI_BEST_PRACTICES.md — 7 incorrect references fixed

Before (wrong) After (correct)
CloudClient Connector (App\Client\Connector)
Illuminate\Http\Client\RequestException Saloon\Exceptions\Request\RequestException
$e->response->status() $e->getResponse()->status()
$e->response->json() $e->getResponse()->json()

The Illuminate\Http\Client\RequestException class does not exist in vendor — this CLI uses Saloon, not Laravel HTTP client. The CloudClient class has never existed in the codebase.

COMMANDS_SUMMARY.md — deleted

Redundant with README.md which already has a comprehensive command reference. The file was incomplete and outdated.

README.md — 2 fixes + 12 new commands documented

Fixes:

  • Added missing application:delete to Applications table
  • Fixed environment:variables description: "Replace env vars from a file" → "Manage environment variables (append, set, replace, delete)"

New commands added (from open PRs):

Command PR
cloud environment:start #70
cloud environment:stop #70
cloud environment:metrics #72
cloud deployment:logs #71
cloud database-cluster:metrics #72
cloud cache:metrics #72
cloud websocket-cluster:metrics #72
cloud websocket-application:metrics #72
cloud env:pull #81
cloud env:push #81
cloud use #80

README now documents all 97 commands (86 existing + 11 new).

Note

The 11 new commands are from open PRs that have not yet been merged. If those PRs are not accepted, the corresponding README entries should be removed. Each entry references its source PR for traceability.

Generated with Claude Code

Josh Salway and others added 2 commits March 17, 2026 06:26
…move redundant COMMANDS_SUMMARY.md

- AI_BEST_PRACTICES.md: Replace incorrect Illuminate\Http\Client\RequestException
  with Saloon\Exceptions\Request\RequestException, replace CloudClient with Connector,
  fix $e->response->status()/json() to $e->getResponse()->status()/json()
- README.md: Add missing application:delete command, fix environment:variables
  description to reflect append/set/replace capabilities
- Delete COMMANDS_SUMMARY.md as it is incomplete and redundant with README.md

Closes laravel#91

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Documents 11 new commands added by our PRs:
- environment:start, environment:stop (laravel#70)
- environment:metrics (laravel#72)
- deployment:logs (laravel#71)
- cache:metrics, database-cluster:metrics (laravel#72)
- websocket-cluster:metrics, websocket-application:metrics (laravel#72)
- env:pull, env:push (laravel#81)
- use (laravel#80)

Also updated environment:variables description to include 'delete' action.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: AI_BEST_PRACTICES.md and COMMANDS_SUMMARY.md contain incorrect information

1 participant