-
Notifications
You must be signed in to change notification settings - Fork 265
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fish and Pwsh Examples #1549
Fish and Pwsh Examples #1549
Conversation
WalkthroughThe documentation for custom widgets in the Wave application has been expanded to provide more comprehensive guidance. The changes include renaming the "Terminal Widgets" section to "Shell Widgets," adding new sections for Web Widgets and Sysinfo Widgets, and introducing more detailed examples for various widget types. The updates aim to clarify configuration options and demonstrate the flexibility of widget creation across different use cases. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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 (1)
docs/docs/customwidgets.mdx (1)
129-130
: Add explanation for Fish shell flagsThe Fish shell example uses
-i
and-l
flags but doesn't explain their purpose. Consider adding a brief explanation of what these flags do:
-i
: Makes the shell interactive-l
: Makes it a login shell
It is very possible that `pwsh` is not in your path. In this case, using `"pwsh"` as the value of `"term:localshellpath"` will not work. In these cases, you will need to provide a direct path to it. This could be somewhere like `"/usr/local/bin/pwsh"` on a Unix system or <code>"C:\\Program Files\\PowerShell\\7\\pwsh.exe"</code> on | ||
Windows. but it may be different on your system. Also note that both `pwsh.exe` and `pwsh` work on Windows, but only `pwsh` works on Unix systems. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix Windows path escaping in PowerShell documentation
The Windows path example uses incorrect escaping. In JSON, backslashes need to be double-escaped.
Update the path example to use proper JSON escaping:
-<code>"C:\\Program Files\\PowerShell\\7\\pwsh.exe"</code>
+<code>"C:\\\\Program Files\\\\PowerShell\\\\7\\\\pwsh.exe"</code>
Committable suggestion skipped: line range outside the PR's diff.
This adds example widgets to the docs for fish and powershell core (pwsh)
Summary by CodeRabbit
New Features
Documentation
customwidgets.mdx
document with more comprehensive guidance.