Shell Example Pictures

[oneirocosm]

• Adds pictures to the fish and pwsh examples
• reformats some tabs as spaces in the example json
• adds missing brackets around some older json examples
• rewords repetitive parts of the shell examples

Summary by CodeRabbit

• Documentation
  • Enhanced documentation for custom widgets in the Wave application.
  • Added detailed descriptions and examples for terminal, command, web, and system information widgets.
  • Introduced new widget types and configurations, including examples for various shell types and sysinfo data display.

[coderabbitai]

Walkthrough

The documentation for custom widgets in the Wave application has been expanded to provide more comprehensive guidance. The update includes detailed explanations of widget configurations, with new examples covering terminal, command, web, and system information widgets. The changes aim to clarify the structure and usage of different widget types, offering more concrete examples for developers to understand and implement custom widgets effectively.

Changes

File	Change Summary
docs/docs/customwidgets.mdx	- Added examples for terminal widgets with fish and pwsh shells - Introduced new command widget examples like speedtest and dua - Added web widget examples for YouTube and GitHub - Included sysinfo widget configurations for CPU and memory monitoring

Poem

🐰 Widgets dancing, code so bright,
From fish to GitHub, a coder's delight!
Terminal, web, and system's gleam,
Wave's custom widgets, a programmer's dream!
Hop along the config's sweet refrain! 🌊

---

🪧 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 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 (2)

docs/docs/customwidgets.mdx (2)

121-133: Consider making the shell path more dynamic

While the example is correct, the hardcoded path /usr/local/bin/fish might not work across different systems. Consider suggesting the use of which fish or similar command to find the correct path.

Consider updating the example to show how to dynamically find the fish shell:

-                "term:localshellpath": "/usr/local/bin/fish",
+                "term:localshellpath": "$(which fish)",

---

Line range hint 207-221: Consider adding installation prerequisites

The example is well-structured, but it might be helpful to add a note about installing dua first, as it's not a standard utility.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cc6da28 and cc20a92.

📒 Files selected for processing (1)

• docs/docs/customwidgets.mdx (11 hunks)

🔇 Additional comments (3)

docs/docs/customwidgets.mdx (3)

150-161: LGTM! Comprehensive cross-platform guidance

The PowerShell example effectively covers both Windows and Unix environments, with clear path guidance for both platforms.

Also applies to: 170-172

---

Line range hint 263-277: LGTM! Clear examples of URL configuration

The examples effectively demonstrate the difference between url and pinnedurl, with appropriate brand icons and clear explanations.

Also applies to: 286-300

---

Line range hint 341-355: LGTM! Well-documented practical examples

The examples effectively demonstrate different sysinfo configurations with practical use cases. The 3-minute build process example is particularly helpful in explaining the purpose of the graph:numpoints parameter.

Also applies to: 364-377

🧰 Tools

🪛 LanguageTool

[uncategorized] ~338-~338: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ave a build process that lasts 3 minutes and you'd like to be able to see the entire...

(COMMA_COMPOUND_SENTENCE)