Skip to content
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

Merged
merged 1 commit into from
Dec 18, 2024
Merged

Fish and Pwsh Examples #1549

merged 1 commit into from
Dec 18, 2024

Conversation

oneirocosm
Copy link
Member

@oneirocosm oneirocosm commented Dec 18, 2024

This adds example widgets to the docs for fish and powershell core (pwsh)

Summary by CodeRabbit

  • New Features

    • Expanded documentation on creating and configuring custom widgets.
    • Introduced new sections for "Web Widgets" and "Sysinfo Widgets" with detailed examples.
    • Updated examples for shell and command widgets, including new commands and configurations.
  • Documentation

    • Enhanced clarity and usability of the customwidgets.mdx document with more comprehensive guidance.

Copy link
Contributor

coderabbitai bot commented Dec 18, 2024

Walkthrough

The 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

File Changes
docs/docs/customwidgets.mdx - Renamed "Example Terminal Widgets" to "Example Shell Widgets"
- Added new "Example Web Widgets" section
- Added new "Example Sysinfo Widgets" section
- Expanded examples for shell, command, web, and system information widgets

Poem

🐰 Widgets dancing, docs so bright,
Shell and web, a coder's delight!
From fish to GitHub, systems glow,
Our Wave docs help your knowledge grow 🌊
A rabbit's guide to widget art! 🚀


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?

❤️ Share
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

Copy link
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 (1)
docs/docs/customwidgets.mdx (1)

129-130: Add explanation for Fish shell flags

The 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
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dbc2be1 and dd12261.

📒 Files selected for processing (1)
  • docs/docs/customwidgets.mdx (1 hunks)

Comment on lines +164 to +165
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&nbsp;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.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

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&nbsp;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.

@oneirocosm oneirocosm merged commit 69bb1d4 into main Dec 18, 2024
9 checks passed
@oneirocosm oneirocosm deleted the sylvie/shell-examples branch December 18, 2024 01:06
@coderabbitai coderabbitai bot mentioned this pull request Dec 18, 2024
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