Fixup configuration example in generated README.md

[NickCao]

Summary by CodeRabbit

• Documentation

  • Updated configuration examples in driver guides with new, more intuitive key names.
  • Revised installation instructions and setup sections to enhance clarity and ease of use.

• Refactor

  • Reorganized the layout of configuration sections across multiple drivers to ensure consistency and improved readability.

[coderabbitai]

Walkthrough

This pull request refactors the YAML configuration examples in multiple README files and in a driver creation template. The changes consistently rename keys from interfaces to export, driver to type, and parameters to config. In addition, the composite driver’s README is rewritten to include a new title, introduction, installation instructions, and configuration examples. These modifications standardize the configuration format and update the documentation across various drivers.

Changes

File(s)	Change Summary
__templates__/create_driver.sh	Updated the YAML example by renaming keys: interfaces → export, driver → type, and parameters → config.
packages/.../jumpstarter-driver-composite/README.md	Complete documentation rewrite: title updated and new sections added for introduction, installation, configuration examples, and API documentation.
packages/.../jumpstarter-driver-[can, corellium, dutlink, http, network, power, probe-rs, pyserial, qemu, raspberrypi, shell, snmp, tftp, yepkit]/README.md	Standardized YAML configuration: updated keys from interfaces to export, driver to type, and parameters to config (with driver-specific references revised).

Possibly related PRs

• fix: reset retry counter after receiving data in exporter reconnect jumpstarter#396: Addresses similar YAML key renaming across various README files.
• add PR comment with PR images URIs jumpstarter#249: Involves comparable modifications to the YAML configuration structure in driver documentation.
• feat: add SOME/IP driver wrapping opensomeip Python binding jumpstarter#391: Focuses on reorganization of YAML keys in README files for multiple drivers.

Suggested reviewers

• mangelajo
• bennyz

Poem

I'm a little rabbit, hopping through code by night,
Renaming keys with a flick—export shines so bright!
Type replaces driver in a rhythmic, neat display,
While config now holds the details, leading the way.
With every hop and every tweak, our docs feel light and free—
Hoppy changes all around, a joy for you and me!

✨ 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.
  • 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[netlify]

✅ Deploy Preview for jumpstarter-docs ready!

Name	Link
🔨 Latest commit	b7284f2
🔍 Latest deploy log	https://app.netlify.com/sites/jumpstarter-docs/deploys/67f793bcfb0e8a000803bc3e
😎 Deploy Preview	https://deploy-preview-406--jumpstarter-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

packages/jumpstarter-driver-composite/README.md (1)

15-21: YAML Configuration Example Matches Standardized Keys
The YAML snippet correctly reflects the new configuration format:

• Top-level key is now export (formerly interfaces).
• The driver type is defined using the type key (previously labeled as driver).
• The configuration parameters are under the config key (renamed from parameters).

For improved clarity, consider adding an inline comment or example parameter within the config section to illustrate expected values or additional configurations.

packages/jumpstarter-driver-shell/README.md (1)

29-33: Optional: Clarify Nested shell Key in Config.
Within the configuration under config, the nested key shell (defining a list of command-line arguments) might be confused with the driver’s name. If this key is intentional, consider renaming it (e.g., to args or exec) for improved clarity.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 12782ff and b69dade.

📒 Files selected for processing (16)

• __templates__/create_driver.sh (1 hunks)
• packages/jumpstarter-driver-can/README.md (1 hunks)
• packages/jumpstarter-driver-composite/README.md (1 hunks)
• packages/jumpstarter-driver-corellium/README.md (1 hunks)
• packages/jumpstarter-driver-dutlink/README.md (1 hunks)
• packages/jumpstarter-driver-http/README.md (1 hunks)
• packages/jumpstarter-driver-network/README.md (1 hunks)
• packages/jumpstarter-driver-power/README.md (1 hunks)
• packages/jumpstarter-driver-probe-rs/README.md (1 hunks)
• packages/jumpstarter-driver-pyserial/README.md (1 hunks)
• packages/jumpstarter-driver-qemu/README.md (1 hunks)
• packages/jumpstarter-driver-raspberrypi/README.md (1 hunks)
• packages/jumpstarter-driver-shell/README.md (1 hunks)
• packages/jumpstarter-driver-snmp/README.md (1 hunks)
• packages/jumpstarter-driver-tftp/README.md (1 hunks)
• packages/jumpstarter-driver-yepkit/README.md (1 hunks)

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

• GitHub Check: pytest-matrix (3.11)
• GitHub Check: pytest-matrix (3.13)
• GitHub Check: pytest-matrix (3.12)
• GitHub Check: e2e
• GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-devspace .devfile/Containerfile.client)
• GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter Dockerfile)
• GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-dev .devfile/Containerfile)
• GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-utils Dockerfile.utils)

🔇 Additional comments (21)

packages/jumpstarter-driver-composite/README.md (4)

1-3: Title and Introduction Updated Appropriately
The updated title (“# Composite Driver”) and descriptive introduction clearly set the context for this package. The concise description of its functionality is informative and aligns with the standardized naming convention.

---

5-9: Clear and Concise Installation Instructions
The installation section using the pip command is straightforward and easy for users to follow. Make sure the package’s published version aligns with this instruction.

---

11-14: Effective Configuration Section Heading
The “## Configuration” header and the introductory line “Example configuration:” effectively guide the reader toward the YAML snippet. This structure aids clarity and usability.

---

23-26: API Reference Placeholder Acknowledged
The “## API Reference” section with the note “Add API documentation here” is a clear placeholder. Remember to update this section with relevant API details once available to maintain consistency in documentation.

packages/jumpstarter-driver-shell/README.md (1)

16-19: Standardized configuration keys applied correctly.
The refactoring properly replaces the old keys with export at the top level, type for the driver, and config for the parameters. This change is clear and enhances consistency across the documentation.

packages/jumpstarter-driver-http/README.md (1)

16-21: Consistent configuration key refactoring applied.
The changes in this configuration snippet successfully update the keys to the new standardized format (export, type, and config). This brings clarity and uniformity to the documentation.

packages/jumpstarter-driver-pyserial/README.md (1)

16-20: Configuration structure updated as per new standards.
Replacing the top-level key with export and the nested keys with type and config enhances clarity in defining the serial driver settings. The snippet is clear, concise, and consistent with the new approach.

packages/jumpstarter-driver-snmp/README.md (2)

16-19: Updated configuration keys reflect the standardized structure.
The changes correctly transition from the old keys to using export, type, and config for the SNMP driver configuration. This enhances consistency with other driver documentations.

---

20-30: Configuration details are complete and clear.
The parameters provided for the SNMP server (including host, user, plug, port, and others) are comprehensive and maintain correct YAML formatting. This example effectively communicates how to set up the SNMP configuration.

packages/jumpstarter-driver-network/README.md (1)

16-21: Network driver configuration updated consistently.
The configuration snippet appropriately uses export for the top-level key, with nested type and config keys replacing the previous structure. This change aligns with the overall initiative to standardize configuration examples across drivers.

packages/jumpstarter-driver-dutlink/README.md (1)

16-21: Consistent Configuration Key Renaming

The YAML configuration now correctly uses the new key names—export instead of the old interfaces, type instead of driver, and config replacing parameters. This change is clear and consistent with the overall initiative across drivers.

packages/jumpstarter-driver-tftp/README.md (1)

16-20: Standardized YAML Configuration for TFTP

The configuration snippet now reflects the standardized keys by replacing interfaces with export, driver with type, and parameters with config. The inclusion of additional configuration options (like root_dir, host, and port) remains intact and well-documented.

packages/jumpstarter-driver-probe-rs/README.md (1)

16-25: Unified Configuration Structure for Probe-rs Driver

The updated configuration uses the new key names (export, type, and config) uniformly. All previously defined parameters, including probe, probe_rs_path, and chip, remain correctly placed. Although the AI summary mentioned the omission of protocol and connect_under_reset, they are still present in the snippet. If intentional, please ensure the documentation clarifies their usage.

__templates__/create_driver.sh (1)

52-58: Template Update for YAML Example

The embedded YAML in the create_driver.sh template now reflects the standardized format by using export as the top-level key and renaming nested keys to type and config. The use of heredoc with delayed variable expansion (via sed post-EOF) is correctly handled.

packages/jumpstarter-driver-qemu/README.md (1)

16-21: QEMU Driver Configuration Updated

The revised configuration snippet correctly adopts the new key names, replacing interfaces with export, changing the nested key from driver to type, and switching parameters to config. This maintains consistency with the changes seen across the other driver README files.

packages/jumpstarter-driver-power/README.md (1)

15-21: Unified Key Updates in Configuration Example
The configuration block has been correctly refactored: the top-level key now reads export (replacing the old interfaces), the driver is now specified by type (instead of driver), and configuration parameters are provided under config (instead of parameters). This change is clear and consistent with the new schema.

packages/jumpstarter-driver-can/README.md (1)

15-21: Consistent YAML Schema Revision
The YAML configuration section now uniformly uses the new keys: export as the top-level key, type for specifying the driver class, and config for configuration details. This improves clarity and consistency across drivers.

packages/jumpstarter-driver-corellium/README.md (2)

15-26: Standardized Configuration Block Updated
The main configuration example is updated to use export instead of interfaces, type instead of driver, and config instead of parameters. The provided example (including project and device details) aligns well with the new conventions.

---

36-52: ExporterConfig Example Uses Updated Keys
The exporter configuration sample correctly reflects the new keys. The usage of export, along with type and config, in the ExporterConfig YAML block is consistent with the rest of the documentation, ensuring clarity for users configuring the exporter.

packages/jumpstarter-driver-raspberrypi/README.md (1)

15-21: Accurate Update for Raspberry Pi Configuration
The configuration block now correctly uses the standardized keys. The top-level export key wraps the raspberrypi configuration, which shows the new type (referring to jumpstarter_driver_raspberrypi.driver.DigitalOutput) and the config section. The example is clear and meets the new configuration specifications.

packages/jumpstarter-driver-yepkit/README.md (1)

15-28: Effective Restructuring of Yepkit Configuration
The configuration example demonstrates the new unified format by replacing interfaces with export, driver with type, and parameters with config. Presenting two separate configuration entries (power and power2) offers clarity on how to handle multiple settings, which is a beneficial enhancement.