Write prompt tutorial, rename prompt mode to spf mode , add develop branch in github workflow, show_panel_footer_info flag

[lazysegtree]

Issues

• Leftover items in spf prompt feature. #753
• Name and Browser Removal #734

Prompt Tutorial

Show footer info flag

flag as true

flag as false

Minimalistic look

Summary by CodeRabbit

Summary by CodeRabbit

• Chores
  • Updated automated workflow to run on both the main and develop branches for improved build and test coverage.
• New Features
  • Added detailed documentation for SPF Prompt modes, including Shell and SPF modes with usage examples and hotkeys.
  • Introduced a configuration option to hide additional footer information in the file panel.
• Bug Fixes
  • Improved prompt UI text formatting and labels for clarity.
  • Refined error messages related to SPF commands for better user understanding.
• Documentation
  • Enhanced hotkey list with distinct entries for opening Shell mode and SPF mode prompts.
  • Added documentation for new configuration option controlling footer info display in the file panel.

[coderabbitai]

Walkthrough

The GitHub Actions workflow was updated to trigger on both main and develop branches for push and pull request events. The prompt UI text and formatting were refined, including mode labels and error messages. A new configuration option was added to control footer info display in file panels. Documentation was extended with details on two prompt modes and corresponding hotkeys.

Changes

File(s)	Change Summary
.github/workflows/superfile-build-test.yml	Updated workflow triggers to include both main and develop branches for push and pull request events. No changes to workflow steps.
src/internal/ui/prompt/consts.go	Changed constant spfModeString from "(Prompt Mode)" to "(SPF Mode)".
src/internal/ui/prompt/model.go	Added space before mode string in prompt border title; simplified SPF prompt hotkey description text.
src/internal/ui/prompt/model_test.go	Updated expected prompt rendering strings to reflect spacing and text changes; adjusted box border widths.
src/internal/ui/prompt/utils.go	Modified error message text by removing "prompt" from "Invalid spf prompt command" to "Invalid spf command".
src/internal/ui/prompt/utils_test.go	Updated test to expect modified error message string without "prompt".
src/internal/common/config_type.go	Added boolean config field ShowPanelFooterInfo to control footer info display in file panel.
src/internal/model_render.go	Modified file panel render logic to conditionally hide footer info based on ShowPanelFooterInfo config.
src/superfile_config/config.toml	Added show_panel_footer_info boolean option with default true.
website/src/content/docs/getting-started/tutorial.md	Added new "SPF Prompt" section describing two prompt modes (Shell and SPF), usage, keybindings, and examples.
website/src/content/docs/list/hotkey-list.md	Split command execution bar hotkey entry into two: shell mode (:) and SPF mode (>), with updated descriptions.
website/src/content/docs/configure/superfile-config.mdx	Documented new show_panel_footer_info boolean configuration option controlling footer info display; fixed grammar in show_image_preview description.

Poem

Two modes to hop and play,
Shell and SPF light the way.
Keys : and > guide the run,
Commands and prompts, all in fun.
Footer info hides or shows,
Bunny cheers as progress grows! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between e0e8cec and 4f11804.

📒 Files selected for processing (4)

• src/internal/common/config_type.go (1 hunks)
• src/internal/model_render.go (1 hunks)
• src/superfile_config/config.toml (1 hunks)
• website/src/content/docs/configure/superfile-config.mdx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (4)

• src/internal/common/config_type.go
• website/src/content/docs/configure/superfile-config.mdx
• src/superfile_config/config.toml
• src/internal/model_render.go

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

website/src/content/docs/getting-started/tutorial.md (1)

181-207: Great addition of SPF Prompt documentation!

The new section clearly explains the two prompt modes (Shell Mode and SPF Mode), their access methods (: and > respectively), available commands, and usage examples. The screenshots are helpful for user understanding.

Minor grammatical correction needed on line 207:

-Press `esc` or `ctrl`+`c` to exit Prompt.
+Press `esc` or `ctrl`+`c` to exit the Prompt.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~207-~207: You might be missing the article “the” here.
Context: ...h)) Pressescorctrl+c` to exit Prompt.

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 283a1f5 and f291156.

⛔ Files ignored due to path filters (2)

• asset/prompt_shell_mode.png is excluded by !**/*.png
• asset/prompt_spf_mode.png is excluded by !**/*.png

📒 Files selected for processing (7)

• src/internal/ui/prompt/consts.go (1 hunks)
• src/internal/ui/prompt/model.go (2 hunks)
• src/internal/ui/prompt/model_test.go (2 hunks)
• src/internal/ui/prompt/utils.go (1 hunks)
• src/internal/ui/prompt/utils_test.go (1 hunks)
• website/src/content/docs/getting-started/tutorial.md (1 hunks)
• website/src/content/docs/list/hotkey-list.md (1 hunks)

✅ Files skipped from review due to trivial changes (5)

• src/internal/ui/prompt/consts.go
• src/internal/ui/prompt/utils.go
• website/src/content/docs/list/hotkey-list.md
• src/internal/ui/prompt/model.go
• src/internal/ui/prompt/model_test.go

🧰 Additional context used

🪛 LanguageTool

website/src/content/docs/getting-started/tutorial.md

[uncategorized] ~207-~207: You might be missing the article “the” here.
Context: ...h)) Pressescorctrl+c` to exit Prompt.

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🔇 Additional comments (1)

src/internal/ui/prompt/utils_test.go (1)

71-71: Correctly updated error message to match implementation changes

The error message has been updated from "Invalid prompt command : abcd" to "Invalid spf command : abcd", which aligns with the broader change of renaming "prompt mode" to "spf mode" throughout the application. This maintains consistency between the test expectations and actual error messages.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

src/internal/model_render.go (1)

125-133: Implementation looks good, but consider aligning variable naming with behavior.

The conditional rendering of footer items based on the HidePanelFooterInfo flag is well-implemented. The logic for handling truncated items by using smaller versions is also a nice touch.

However, the naming of the configuration flag seems counterintuitive since when HidePanelFooterInfo is true, it actually shows additional footer info, not hides it. Consider renaming this flag to ShowPanelFooterInfo to make the behavior more intuitive and consistent with other similar flags like show_image_preview.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between f291156 and c2e96b3.

📒 Files selected for processing (4)

• src/internal/common/config_type.go (1 hunks)
• src/internal/model_render.go (1 hunks)
• src/superfile_config/config.toml (1 hunks)
• website/src/content/docs/configure/superfile-config.mdx (1 hunks)

✅ Files skipped from review due to trivial changes (2)

• src/superfile_config/config.toml
• src/internal/common/config_type.go

🧰 Additional context used

🪛 LanguageTool

website/src/content/docs/configure/superfile-config.mdx

[grammar] ~108-~108: After the auxiliary verb ‘do’, use the base form of a verb. Did you mean “show”?
Context: ...ode and sort type. false => Does not shows additional footer info for file panel ...

(AUXILIARY_DO_WITH_INCORRECT_VERB_FORM)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Analyze (go)

[lazysegtree]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.