Skip to content

GH#14039: tighten video-higgsfield-ui.md (188→158 lines)#14049

Open
alex-solovyev wants to merge 1 commit intomainfrom
chore/tighten-higgsfield-ui-doc
Open

GH#14039: tighten video-higgsfield-ui.md (188→158 lines)#14049
alex-solovyev wants to merge 1 commit intomainfrom
chore/tighten-higgsfield-ui-doc

Conversation

@alex-solovyev
Copy link
Copy Markdown
Collaborator

@alex-solovyev alex-solovyev commented Mar 30, 2026

Summary

  • Remove redundant CLI Options table (28 lines) — every flag is already demonstrated in the Commands code block
  • Compress Prompt Tips from 3 bullet points to single flowing paragraph
  • Tighten prose in quality ranking and pipeline brief sections

Runtime Testing

  • Risk level: Low (docs/agent prompts only)
  • Verification: self-assessed — no code changes, only markdown prose reduction
  • Content preservation verified: all code blocks, URLs, command examples, model tables, app slugs, seed ranges, pipeline JSON, troubleshooting commands, and Related links intact

Closes #14039


aidevops.sh v3.5.454 plugin for OpenCode v1.3.7 with claude-opus-4-6 spent 2m and 5,947 tokens on this as a headless worker.

Summary by CodeRabbit

  • Documentation
    • Clarified unlimited model selection behavior and cost implications for standard routes
    • Simplified video processing setup descriptions while preserving pipeline details
    • Removed CLI Options reference table
    • Reformatted Prompt Tips with labeled examples for Images, Videos, and Modifiers

…nt CLI Options table, compress prompt tips and prose
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 30, 2026

Walkthrough

Documentation tightening for the Higgsfield UI agent file: clarified --prefer-unlimited model selection behavior, simplified Remotion setup description by removing feature enumeration, removed the CLI Options table, and reformatted Prompt Tips into labeled single-line examples.

Changes

Cohort / File(s) Summary
Agent Documentation
.agents/content/video-higgsfield-ui.md
Simplified agent doc by removing CLI Options table (33 lines), condensing Remotion setup description, reworking Prompt Tips formatting into labeled examples, and clarifying --prefer-unlimited default behavior. Net reduction of 30 lines while preserving core guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

Docs once dense with tables wide,
Now flow with clarity as guide,
Prompt tips shine in single line—
Agent wisdom, lean and fine! ✨📝

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the primary change: tightening the documentation by reducing line count from 188 to 158 lines through content restructuring and compression.
Linked Issues check ✅ Passed The PR addresses issue #14039 by classifying the file as an instruction doc and tightening prose (removing redundant CLI table, compressing Prompt Tips, tightening prose) while preserving all code blocks, URLs, and command examples as required.
Out of Scope Changes check ✅ Passed All changes are scoped to the stated objective of tightening the documentation file; no unrelated modifications to code, configuration, or other files are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/tighten-higgsfield-ui-doc

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 and usage tips.

@github-actions
Copy link
Copy Markdown
Contributor

🔍 Code Quality Report

�[0;35m[MONITOR]�[0m Code Review Monitoring Report

SonarCloud: 0 bugs, 0 vulnerabilities, 1 code smells

Mon Mar 30 09:21:36 UTC 2026: Code review monitoring started
Mon Mar 30 09:21:37 UTC 2026: SonarCloud - Bugs: 0, Vulnerabilities: 0, Code Smells: 1

📈 Current Quality Metrics

  • BUGS: 0
  • CODE SMELLS: 1
  • VULNERABILITIES: 0

Generated on: Mon Mar 30 09:21:39 UTC 2026


Generated by AI DevOps Framework Code Review Monitoring

@sonarqubecloud
Copy link
Copy Markdown

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request streamlines the documentation in video-higgsfield-ui.md by simplifying the quality ranking description, condensing the prompt tips into a single paragraph, and removing the detailed CLI Options table. I have no feedback to provide.

coderabbitai[bot]
coderabbitai bot previously requested changes Mar 30, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (2)
.agents/content/video-higgsfield-ui.md (2)

40-64: Consider adding a condensed CLI options reference.

The PR removed a 28-line CLI Options table, stating that flags are demonstrated in the Commands examples. While the examples do show flags in context, users seeking a quick reference of all available options now need to scan through 24 command examples to discover options.

Consider adding a minimal one-line options reference after the Commands section for quick lookup, such as:

**Common options:** `--model` `--aspect` `--quality` `--batch` `--enhance` `--preset` `--seed` `--image-file` `--timeout` `--duration` `--output` `--project` `--headed` — see command examples for usage context.

This preserves the line savings while providing a scannable reference. Alternatively, the removal is acceptable if the Commands examples are considered sufficient documentation.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.agents/content/video-higgsfield-ui.md around lines 40 - 64, Add a
single-line condensed CLI options reference immediately after the Commands
examples to restore quick discoverability; include a short header like "Common
options:" followed by the core flags shown across the examples (e.g., --model
--aspect --quality --batch --enhance --preset --seed --image-file --timeout
--duration --output --project --headed) and note that usage context is in the
command examples (references: higgsfield-helper.sh image, video, edit, lipsync,
manage-assets, etc.); keep it one concise line to replace the removed 28-line
table.

142-142: Consider improving readability of the compressed Prompt Tips.

The reformatted Prompt Tips section compresses three bullet points into a single dense line with multiple nested concepts. While compact, this format may be harder for users to scan quickly compared to the original bullet-point structure.

If maintaining the compact format is important, consider using line breaks after each category for better scannability:

 ## Prompt Tips
 
-Images: camera + lighting + lens (`"Golden retriever, golden hour, shallow DOF, Canon EOS R5, 85mm, bokeh"`). Videos: camera movement first (`"Smooth cinematic pan left to right, golden hour, 24fps film grain"`). Modifiers: photorealistic `"8k, highly detailed"` | cinematic `"anamorphic, film grain, color graded"` | portrait `"studio lighting, bokeh, 85mm"`.
+**Images:** camera + lighting + lens (`"Golden retriever, golden hour, shallow DOF, Canon EOS R5, 85mm, bokeh"`).  
+**Videos:** camera movement first (`"Smooth cinematic pan left to right, golden hour, 24fps film grain"`).  
+**Modifiers:** photorealistic `"8k, highly detailed"` | cinematic `"anamorphic, film grain, color graded"` | portrait `"studio lighting, bokeh, 85mm"`.

This preserves brevity while improving visual hierarchy.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.agents/content/video-higgsfield-ui.md at line 142, The "Prompt Tips"
section in .agents/content/video-higgsfield-ui.md compresses Images, Videos and
Modifiers into one dense line; split that single line into three short lines (or
bullet points) — one for Images (`"Golden retriever, golden hour, shallow DOF,
Canon EOS R5, 85mm, bokeh"`), one for Videos (`"Smooth cinematic pan left to
right, golden hour, 24fps film grain"`), and one for Modifiers (`photorealistic
"8k, highly detailed"` | cinematic `"anamorphic, film grain, color graded"` |
portrait `"studio lighting, bokeh, 85mm"`), preserving the same examples and
order but adding a line break after each category to restore scannability while
keeping the compact wording.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.agents/content/video-higgsfield-ui.md:
- Line 91: Clarify that `--prefer-unlimited` refers to web UI model-routing
behavior (not a CLI flag) by updating the text to state it uses the web routing
maps `IMAGE_MODEL_URL_MAP` and `UNLIMITED_MODELS`; alternatively, if you
intended a CLI flag, implement and expose `--prefer-unlimited` in the helper
script's argument parsing and update the Commands examples to show its actual
usage. Locate references to `--prefer-unlimited` in this doc, confirm the helper
scripts for any existing flag, and then either rephrase the doc to point to the
UI routing logic (`IMAGE_MODEL_URL_MAP`, `UNLIMITED_MODELS`) or add the flag
implementation and corresponding example commands.

---

Nitpick comments:
In @.agents/content/video-higgsfield-ui.md:
- Around line 40-64: Add a single-line condensed CLI options reference
immediately after the Commands examples to restore quick discoverability;
include a short header like "Common options:" followed by the core flags shown
across the examples (e.g., --model --aspect --quality --batch --enhance --preset
--seed --image-file --timeout --duration --output --project --headed) and note
that usage context is in the command examples (references: higgsfield-helper.sh
image, video, edit, lipsync, manage-assets, etc.); keep it one concise line to
replace the removed 28-line table.
- Line 142: The "Prompt Tips" section in .agents/content/video-higgsfield-ui.md
compresses Images, Videos and Modifiers into one dense line; split that single
line into three short lines (or bullet points) — one for Images (`"Golden
retriever, golden hour, shallow DOF, Canon EOS R5, 85mm, bokeh"`), one for
Videos (`"Smooth cinematic pan left to right, golden hour, 24fps film grain"`),
and one for Modifiers (`photorealistic "8k, highly detailed"` | cinematic
`"anamorphic, film grain, color graded"` | portrait `"studio lighting, bokeh,
85mm"`), preserving the same examples and order but adding a line break after
each category to restore scannability while keeping the compact wording.
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 4165cb41-71ee-4524-812e-41ad97deccb0

📥 Commits

Reviewing files that changed from the base of the PR and between 78e64a4 and fb27f5d.

📒 Files selected for processing (1)
  • .agents/content/video-higgsfield-ui.md

| WAN 2.2 | `wan2` | 1cr | No |

Quality ranking (product shots): GPT → Seedream 4.5 → FLUX → Kontext → ... `--prefer-unlimited` (default) auto-selects best unlimited model via dedicated routes (e.g., `/nano-banana-pro`) — standard `/image/` routes cost credits even for subscribed models. Soul presets: All, New, TikTok Core, Instagram Aesthetics, Camera Presets, Beauty, Mood, Surreal, Graphic Art.
Quality ranking: GPT → Seedream 4.5 → FLUX → Kontext → ... `--prefer-unlimited` (default) selects best unlimited model via dedicated routes (`/nano-banana-pro`) — standard `/image/` routes cost credits even for subscribers. Soul presets: All, New, TikTok Core, Instagram Aesthetics, Camera Presets, Beauty, Mood, Surreal, Graphic Art.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Check if --prefer-unlimited flag exists in the higgsfield-helper.sh script

# Search for --prefer-unlimited flag definition and usage
rg -n --type=sh -C5 'prefer-unlimited' .agents/scripts/

# Search for route handling logic in the playwright automator
rg -n -C5 'nano-banana-pro|/image/' .agents/scripts/higgsfield/

Repository: marcusquinn/aidevops

Length of output: 16484


Clarify whether --prefer-unlimited describes CLI behavior or web UI routing logic.

The documentation describes real routing behavior (unlimited feature pages like /nano-banana-pro vs. standard /image/ routes that cost credits), but the framing is unclear. No --prefer-unlimited CLI flag was found in the scripts—the underlying mechanism is the web UI's model routing logic (IMAGE_MODEL_URL_MAP and UNLIMITED_MODELS in the Higgsfield automation code), not a CLI option.

Either clarify that this section describes web UI behavior specifically, or if --prefer-unlimited is intended as a documented CLI flag, verify it's exposed in the helper script's argument parsing and update the Commands examples section (lines 40–64) to show actual usage.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.agents/content/video-higgsfield-ui.md at line 91, Clarify that
`--prefer-unlimited` refers to web UI model-routing behavior (not a CLI flag) by
updating the text to state it uses the web routing maps `IMAGE_MODEL_URL_MAP`
and `UNLIMITED_MODELS`; alternatively, if you intended a CLI flag, implement and
expose `--prefer-unlimited` in the helper script's argument parsing and update
the Commands examples to show its actual usage. Locate references to
`--prefer-unlimited` in this doc, confirm the helper scripts for any existing
flag, and then either rephrase the doc to point to the UI routing logic
(`IMAGE_MODEL_URL_MAP`, `UNLIMITED_MODELS`) or add the flag implementation and
corresponding example commands.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--prefer-unlimited is a real CLI flag — defined in playwright-automator.mjs:221 and tested in higgsfield-commands.mjs:2182. The search missed it because it only searched .agents/scripts/ shell files, not the .mjs files in the higgsfield/ subdirectory. No change needed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify --prefer-unlimited flag in the .mjs files
rg -n 'prefer-unlimited' .agents/scripts/higgsfield/ --type-add 'mjs:*.mjs' --type mjs -C3

# Also check higgsfield-commands.mjs around line 2182
rg -n 'prefer-unlimited' .agents/scripts/higgsfield/higgsfield-commands.mjs -C3

Length of output: 5638


@alex-solovyev, confirmed — my apologies for the noise. The verification shows --prefer-unlimited is fully implemented:

  • playwright-automator.mjs:221 — help text documents it as "Auto-select unlimited models when available (default: on)"
  • higgsfield-common.mjs:284,287 — flag parsed and mapped to preferUnlimited option
  • higgsfield-commands.mjs:2182–2188 — CLI flag parsing tested with assertions for both --prefer-unlimited and --no-prefer-unlimited

The original search missed it because it was scoped to --type=sh, excluding the .mjs files in .agents/scripts/higgsfield/. No change needed.

🐇 ears drooping slightly

(\_/)
( •_•)
/ >🔍  searched the wrong forest...

✏️ Learnings added
Learnt from: alex-solovyev
Repo: marcusquinn/aidevops PR: 14049
File: .agents/content/video-higgsfield-ui.md:91-91
Timestamp: 2026-03-30T09:27:21.007Z
Learning: In marcusquinn/aidevops, CLI flags for the Higgsfield automation toolchain (e.g., `--prefer-unlimited`) are defined and parsed in `.agents/scripts/higgsfield/*.mjs` files (ES modules), not in shell scripts. When verifying CLI flag existence, always search `.mjs` files in `.agents/scripts/higgsfield/` using `rg` with `--type-add 'mjs:*.mjs' --type mjs`, in addition to `.sh` files. Key files: `playwright-automator.mjs` (help/docs), `higgsfield-common.mjs` (flag parsing), `higgsfield-commands.mjs` (tests).

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.


🧠 Learnings used
Learnt from: marcusquinn
Repo: marcusquinn/aidevops PR: 3840
File: .agents/tools/research/providers/wappalyzer.md:37-37
Timestamp: 2026-03-08T06:46:42.196Z
Learning: In marcusquinn/aidevops, the internal Node.js wrapper used by `.agents/scripts/wappalyzer-helper.sh` is `.agents/scripts/wappalyzer-detect.mjs` (ES module, `.mjs` extension — not `.js`). The helper script references it at lines 27 and 103. Any doc or review comment suggesting `.js` is incorrect.

Learnt from: alex-solovyev
Repo: marcusquinn/aidevops PR: 13484
File: .agents/services/communications/google-chat.md:18-18
Timestamp: 2026-03-30T00:27:14.196Z
Learning: In marcusquinn/aidevops, `google-chat-helper.sh` referenced in `.agents/services/communications/google-chat.md` is a planned/future helper script that is intentionally documented before its implementation exists in the repository. Do not flag its absence as a missing file or broken reference in reviews.

Learnt from: marcusquinn
Repo: marcusquinn/aidevops PR: 0
File: :0-0
Timestamp: 2026-03-28T10:23:27.439Z
Learning: In marcusquinn/aidevops, paths in `## Related` sections of `.agents/tools/git/` documents (e.g., `worktrunk.md`, `conflict-resolution.md`) use bare agent-readable doc pointers such as `workflows/git-workflow.md` — without filesystem-relative prefixes like `../../`. This is an intentional codebase convention for agent navigation, not broken markdown links. Do not flag these as incorrect relative paths.

Learnt from: marcusquinn
Repo: marcusquinn/aidevops PR: 0
File: :0-0
Timestamp: 2026-03-08T06:04:29.617Z
Learning: In runway-helper.sh, `--audio | -a` flags have two distinct behaviors: one path takes a boolean (true/false) validated by a case statement at lines 184-196, while other occurrences of `--audio | -a` accept URLs and do not require boolean validation.

Learnt from: marcusquinn
Repo: marcusquinn/aidevops PR: 3842
File: .agents/tools/content/summarize.md:0-0
Timestamp: 2026-03-08T20:13:11.476Z
Learning: In marcusquinn/aidevops, the correct Zhipu AI provider configuration for `.agents/tools/content/summarize.md` (steipete/summarize CLI) is: provider label `Z.AI (Zhipu)`, model ID `zai/glm-4.7`, and API key env var `Z_AI_API_KEY` (alias `ZAI_API_KEY`). The values `zhipu/glm-4` and `ZHIPU_API_KEY` are incorrect for this CLI. Fixed in commit 0e8e46b on PR `#3842`.

Learnt from: marcusquinn
Repo: marcusquinn/aidevops PR: 12005
File: .agents/tools/voice/cloud-voice-agents.md:143-146
Timestamp: 2026-03-28T16:34:14.801Z
Learning: In `.agents/tools/voice/cloud-voice-agents.md`, the `"<unit>"` string in MiniCPM-o 2.6 streaming_prefill content arrays (e.g., `{"role": "user", "content": ["<unit>", chunk]}`) is a valid and required TDM (time-division multiplexing) boundary marker in the official MiniCPM-o 2.6 streaming API. Do not flag it as incorrect or undocumented. The official repo uses `["<unit>", image, audio]` for multimodal chunks and `["<unit>", chunk]` for audio-only streaming.

Learnt from: CR
Repo: marcusquinn/aidevops PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-17T02:07:48.870Z
Learning: Applies to **/AGENTS.md : Limit root AGENTS.md to ~50-100 max instructions with universal applicability to >80% of tasks

@alex-solovyev alex-solovyev dismissed coderabbitai[bot]’s stale review March 30, 2026 09:26

Finding was incorrect — --prefer-unlimited flag exists in playwright-automator.mjs:221 and is tested in higgsfield-commands.mjs:2182. The bot search missed .mjs files.

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.

regression: simplification: tighten agent doc Higgsfield UI Automator (.agents/content/video-higgsfield-ui.md, 188 lines)

1 participant