Skip to content

Conversation

@nhussein11
Copy link
Collaborator

📝 Description

This pull request adds comprehensive documentation for Zombienet in .reference/tools/zombienet.md. The new content provides an overview of Zombienet, installation instructions, configuration details, usage examples, and links to further resources. This update transforms the file from a placeholder to a full reference guide, making it much easier for developers to understand and use Zombienet for testing Polkadot SDK-based blockchain networks.

Documentation improvements:

  • Added an introduction and key features section explaining what Zombienet is and its main capabilities.
  • Provided detailed installation instructions for multiple platforms (executable, Nix, Docker), including setup commands and usage examples.
  • Explained provider options (Kubernetes, Podman, native), requirements, and features for each, helping users choose the appropriate backend.
  • Included configuration file examples (TOML and JSON), CLI command references, and step-by-step instructions for spawning networks and running tests.
  • Linked to external resources, tutorials, and support channels for further learning and troubleshooting.

🔍 Review Preference

Choose one:

  • ✅ I have time to handle formatting/style feedback myself
  • ⚡ Docs team handles formatting (check "Allow edits from maintainers")

🤖 AI-Ready Docs

If content changed, regenerate AI files:

  • ✅ I ran python3 scripts/generate_llms.py
  • ⚡ Docs team will regenerate (check "Allow edits from maintainers")

✅ Checklist

nhussein11 and others added 2 commits December 10, 2025 19:16
* Introduce Zombienet as a testing framework for Polkadot SDK-based blockchain networks.
* Detail installation methods including executable, Nix, and Docker.
* Outline key features, configuration options, and CLI commands for network spawning and testing.
* Provide examples for basic configuration and test file structure.

Co-authored-by: [Your Name] <[email protected]>
@nhussein11 nhussein11 self-assigned this Dec 10, 2025
Copilot AI review requested due to automatic review settings December 10, 2025 22:20
@nhussein11 nhussein11 requested a review from a team as a code owner December 10, 2025 22:20
@nhussein11 nhussein11 added B0 - Needs Review Pull request is ready for review C1 - Medium Medium priority task A0 - New Content Pull request contains new content pages labels Dec 10, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR transforms the Zombienet documentation from a placeholder to a comprehensive reference guide. It provides detailed information about Zombienet, a testing framework for Polkadot SDK-based blockchain networks, including installation methods, provider configurations, network spawning, and test writing capabilities.

  • Added complete documentation structure with installation instructions for multiple platforms (executable, Nix, Docker)
  • Documented three provider options (Kubernetes, Podman, native) with requirements and features
  • Included configuration examples in both TOML and JSON formats, CLI commands, and test DSL usage

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Zombienet supports different backend providers for running nodes: [Kubernetes](https://kubernetes.io/){target=\_blank}, [Podman](https://podman.io/){target=\_blank}, and native (local processes). Specify the provider using the `--provider` flag or in your network configuration file:

```bash
zombienet spawn network.toml --provider INSERT_PROVIDER
Copy link
Contributor

Choose a reason for hiding this comment

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

List the different values for provider.

Co-authored-by: Bruno Galvao <[email protected]>
Co-authored-by: Copilot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A0 - New Content Pull request contains new content pages B0 - Needs Review Pull request is ready for review C1 - Medium Medium priority task

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants