docs: Update CLI docs to match spec#93
Conversation
📝 WalkthroughWalkthroughDocumentation-only update that removes the Homebrew CLI installation section, corrects ChangesCLI Documentation Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Rice (invisicat)
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@cli/profile-and-utilities.mdx`:
- Line 80: The whoami command description uses passive voice and is inconsistent
with the style in cli/authentication.mdx. Update the description to use active
voice and second person perspective. Replace the phrase "Returns an error with a
login hint if your session has expired" with "you'll see a hint to re-run
`photon login`" and ensure the command name is properly formatted with backticks
to align with the documentation guidelines used in cli/authentication.mdx.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2e1feb7d-6898-4473-b9ef-485a8a23fe9e
⛔ Files ignored due to path filters (5)
images/cli/billing/demo-billing.webmis excluded by!**/*.webmimages/cli/billing/demo-regenerate-secret.webmis excluded by!**/*.webmimages/cli/billing/demo-upgrade.webmis excluded by!**/*.webmimages/cli/overview/demo-overview.webmis excluded by!**/*.webmimages/cli/projects/demo-create.webmis excluded by!**/*.webm
📒 Files selected for processing (16)
.gitignorecli/authentication.mdxcli/billing.mdxcli/installation.mdxcli/overview.mdxcli/profile-and-utilities.mdxcli/projects.mdxcli/spectrum.mdximages/cli/authentication/login-cli.avifimages/cli/authentication/login-web.avifimages/cli/authentication/whoami-cli.avifimages/cli/billing/free.avifimages/cli/billing/paid.avifimages/cli/projects/projects-ls.avifimages/cli/projects/projects-show.avifimages/cli/spectrum/spectrum-lines.avif
💤 Files with no reviewable changes (1)
- cli/installation.mdx
📜 Review details
🧰 Additional context used
📓 Path-based instructions (1)
**/*.mdx
📄 CodeRabbit inference engine (AGENTS.md)
**/*.mdx: Pages should be written as MDX files with YAML frontmatter
Use active voice and second person ("you") in documentation
Keep sentences concise with one idea per sentence in documentation
Use sentence case for headings in documentation
Bold UI elements in documentation (e.g., Click Settings)
Use code formatting for file names, commands, paths, and code references in documentation
Files:
cli/spectrum.mdxcli/overview.mdxcli/authentication.mdxcli/billing.mdxcli/profile-and-utilities.mdxcli/projects.mdx
🔇 Additional comments (11)
cli/spectrum.mdx (2)
19-19: LGTM!
69-72: LGTM!cli/projects.mdx (3)
40-48: LGTM!
50-56: LGTM!
17-20: LGTM!Also applies to: 30-32, 92-95, 133-136
.gitignore (1)
3-3: LGTM!cli/authentication.mdx (2)
16-23: LGTM!
36-40: ⚡ Quick winCross-file inconsistency in whoami description.
The session-expiry message here ("you'll see a hint to re-run
photon login") differs from the version incli/profile-and-utilities.mdxline 80 ("Returns an error with a login hint"). The version here uses more active voice and second person, which aligns better with the documentation guidelines. Recommend updatingprofile-and-utilities.mdxto match this phrasing for consistency.Source: Coding guidelines
cli/billing.mdx (2)
27-34: LGTM!
51-54: ⚡ Quick winVerify video element HTML syntax.
The
<video>element is self-closing:<video src="..." ... />. Standard HTML video elements should use opening and closing tags:<video ...></video>. Verify that your MDX processor supports self-closing video syntax; if not, this may cause rendering issues.cli/overview.mdx (1)
36-39: ⚡ Quick winVerify video element HTML syntax (self-closing tag).
Like the video elements in
cli/billing.mdx, this uses self-closing syntax:<video ... />. Confirm this is supported by your MDX setup; standard HTML requires opening and closing tags:<video ...></video>.
| ``` | ||
|
|
||
| Prints your user ID, email, and name. Returns an error with a login hint if your session has expired. | ||
| Prints your name, email, and the backend you're signed in to. Returns an error with a login hint if your session has expired. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Extract and compare whoami descriptions from both files
echo "=== profile-and-utilities.mdx (line 80) ==="
sed -n '80p' cli/profile-and-utilities.mdx
echo -e "\n=== authentication.mdx (line 36) ==="
sed -n '36p' cli/authentication.mdxRepository: photon-hq/docs
Length of output: 400
Update whoami description to match active voice style in cli/authentication.mdx.
Line 80 currently reads: "Prints your name, email, and the backend you're signed in to. Returns an error with a login hint if your session has expired."
This conflicts with the cli/authentication.mdx documentation for the same command, which uses: "If the session has expired, you'll see a hint to re-run photon login."
Align line 80 to use active voice and second person, and include code formatting for the suggested action. Change "Returns an error with a login hint" to something like "you'll see a hint to re-run photon login" to follow the documentation guidelines consistently.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@cli/profile-and-utilities.mdx` at line 80, The whoami command description
uses passive voice and is inconsistent with the style in cli/authentication.mdx.
Update the description to use active voice and second person perspective.
Replace the phrase "Returns an error with a login hint if your session has
expired" with "you'll see a hint to re-run `photon login`" and ensure the
command name is properly formatted with backticks to align with the
documentation guidelines used in cli/authentication.mdx.
Source: Coding guidelines
Changes
Media
.avif) and demo videos (.webm) across the CLI pages, wrapped in<Frame>:photon login(CLI + browser approval),photon whoamibilling showon free vs. paid, plus a checkout demoprojects ls,projects show, create wizard, secret rotation, and upgrade demosspectrum lines lsAccuracy fixes
projects create: corrected--locationvalue (United States, the default) and documented the real flags (-n/--name,-l/--location,--spectrum/--no-spectrum,--template,--observability).whoami: now described as printing name, email, and backend (was user ID/email/name).profile update: replaced the nonexistent--display-nameexample with real developer/org flags and a pointer to--help.spectrum profile update:--display-name→--first-name/--last-name.Need help on this PR? Tag
/codesmithwith what you need. Autofix is disabled.Summary by CodeRabbit
Documentation
Chores