Skip to content

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

@JoshSalway

Description

@JoshSalway

Description

Several markdown documentation files contain incorrect or outdated information:

AI_BEST_PRACTICES.md

  1. References wrong exception class — Line 13 uses Illuminate\Http\Client\RequestException but the CLI uses Saloon, which throws Saloon\Exceptions\Request\RequestException. The Illuminate class does not even exist in the vendor directory.

  2. References non-existent class — References CloudClient throughout, but the actual class is App\Client\Connector.

  3. Wrong error handling pattern — Shows $e->response->status() and $e->response->json() which is the Laravel HTTP client pattern. Saloon uses $e->getResponse()->status() and $e->getResponse()->json().

COMMANDS_SUMMARY.md

  1. Missing commands — Only lists a subset of the 87+ available commands
  2. Missing options — Many commands have options not documented
  3. Missing application:create and application:delete — Key CRUD operations omitted

README.md

  1. Missing application:delete from the Applications table
  2. environment:variables description is misleading — Says "Replace env vars from a file" but the command supports append, set, and replace actions

Suggested fix

  • Update AI_BEST_PRACTICES.md to use Saloon\Exceptions\Request\RequestException and Connector class
  • Either update COMMANDS_SUMMARY.md to be comprehensive or delete it (README already has a complete command reference)
  • Fix the two README inaccuracies

Environment

  • Cloud CLI: v0.1.14

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions