Skip to content

docs: fix fleet deployment example line continuations - #925

Draft
rayanakarthikeyan wants to merge 3 commits into
FailproofAI:mainfrom
rayanakarthikeyan:fix-fleet-deploy-docs
Draft

rayanakarthikeyan wants to merge 3 commits into
FailproofAI:mainfrom
rayanakarthikeyan:fix-fleet-deploy-docs

Conversation

@rayanakarthikeyan

Copy link
Copy Markdown

Description

The Cloud CLI README places inline comments after the backslashes in the multi-line fp fleet deploy example. A shell treats each backslash as escaping a space instead of continuing the command, so copying the example splits it into separate commands and fails on the following --add/--remove lines.

Move the explanations onto their own lines before the example, leaving each continuation backslash at the end of its line. Include a dated documentation changelog entry.

Type of Change

  • Documentation

Validation

  • Reproduced the original failure in Bash with an fp stub, then confirmed the revised example exits successfully and passes both --add pairs and the --remove pair to a single call. The stub performs no deployment or network access.
  • git diff --check passes.
  • No application code changes. Bun is unavailable in the local environment, so the application checks below were not run locally.

Checklist

  • bun run lint passes
  • bunx tsc --noEmit passes
  • bun run test:run passes
  • bun run build succeeds

Replaces #924 after a source-branch naming cleanup. The original commits and draft status are preserved.

@coderabbitai

coderabbitai Bot commented Oct 21, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

Thanks @rayanakarthikeyan for your contribution to Failproof AI! 🙌

We'd love to discuss your PR and welcome you to our community.

Discord: https://discord.befailproof.ai/
Reddit: https://www.reddit.com/r/failproofai/

This branch has not been deployed

No deployments
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.

1 participant