Fix doc references to jumpstarter.drivers.*

[NickCao]

Summary by CodeRabbit

• Documentation
  • Updated references and configuration examples to use a consistent naming convention for drivers, clients, and testing components, improving clarity and alignment across the documentation.

[coderabbitai]

Walkthrough

The documentation has been updated to reflect a new naming convention for driver and client references. Several files now use underscore notation (e.g., jumpstarter_driver_pyserial) instead of dot notation (e.g., jumpstarter.drivers.pyserial). Changes affect the PySerial and SDWire drivers, the exporter configuration, the testing framework, and client/exporter YAML examples by correcting module and namespace references across the documentation.

Changes

File(s)	Change Summary
docs/.../api-reference/drivers/pyserial.md	Updated PySerial driver and client references from “jumpstarter.drivers.pyserial” to “jumpstarter_driver_pyserial” in both the driver declaration and documentation.
docs/.../api-reference/drivers/sdwire.md	Revised the StorageMuxClient class reference from “jumpstarter.drivers.storage.client” to “jumpstarter_driver_opendal.client”.
docs/.../cli/exporters.md	Modified driver type declarations for storage (MockStorageMux), power (MockPower), and network (EchoNetwork); changed from “jumpstarter.drivers.” to “jumpstarter_driver_” notation.
docs/.../cli/run-tests.md	Updated JumpstarterTest class reference from “jumpstarter.testing.pytest” to “jumpstarter_testing.pytest”.
docs/.../config.md	Changed client configuration ‘allow’ field and exporter configuration type fields (e.g., for PduPower and PySerial) from dot notation to underscore notation.

Suggested reviewers

• mangelajo
• bennyz

Poem

I’m a rabbit hopping through lines of code,
Celebrating changes on this scholarly road.
Names transform from dots to underscores neat,
Making our docs both tidy and sweet.
With whiskers twitching in digital delight,
I cheer for updates from morning till night!

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 36ed4aa and 54ca798.

📒 Files selected for processing (5)

• docs/source/api-reference/drivers/pyserial.md (3 hunks)
• docs/source/api-reference/drivers/sdwire.md (1 hunks)
• docs/source/cli/exporters.md (1 hunks)
• docs/source/cli/run-tests.md (1 hunks)
• docs/source/config.md (2 hunks)

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

• docs/source/api-reference/drivers/sdwire.md
• docs/source/api-reference/drivers/pyserial.md

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

• 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-dev .devfile/Containerfile)
• GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter Dockerfile)

🔇 Additional comments (4)

docs/source/cli/run-tests.md (1)

52-54: Update class reference for JumpstarterTest: The autoclass directive now references jumpstarter_testing.pytest.JumpstarterTest using underscore notation instead of the legacy dot notation. This change aligns with the updated naming convention across the documentation.

docs/source/cli/exporters.md (1)

56-60: Update exporter driver type references: The YAML configuration for exporter drivers has been updated to use the new underscore notation (e.g., jumpstarter_driver_opendal.driver.MockStorageMux, jumpstarter_driver_power.driver.MockPower, and jumpstarter_driver_network.driver.EchoNetwork) instead of the older dot notation. This ensures consistency with the revised driver module naming.

docs/source/config.md (2)

61-64: Modify client driver allow field: The allowed driver namespace pattern in the client configuration has been updated from dot notation ("jumpstarter.drivers.") to underscore notation ("jumpstarter_drivers_"). Verify that the configuration parser and driver auto-loader correctly interpret this new wildcard format.

---

154-161: Update exporter driver type fields: Within the exporter configuration snippet, the driver type fields for "power" and "serial" have been changed to use underscore notation ("jumpstarter_driver_power.driver.PduPower" and "jumpstarter_driver_pyserial.driver.PySerial"). This modification aligns with the overall renaming initiative.

---

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

• 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. (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.