{
  "pages": [
    {
      "description": "Guidelines for contributing to rtl_buddy documentation, including the frontmatter convention, writing style, and what is auto-generated.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/CONTRIBUTING/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/CONTRIBUTING/#frontmatter",
          "slug": "frontmatter",
          "title": "Frontmatter",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/CONTRIBUTING/frontmatter.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/CONTRIBUTING/#writing-style",
          "slug": "writing-style",
          "title": "Writing style",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/CONTRIBUTING/writing-style.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/CONTRIBUTING/#page-structure",
          "slug": "page-structure",
          "title": "Page structure",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/CONTRIBUTING/page-structure.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/CONTRIBUTING/#auto-generated-pages",
          "slug": "auto-generated-pages",
          "title": "Auto-generated pages",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/CONTRIBUTING/auto-generated-pages.md"
        }
      ],
      "slug": "CONTRIBUTING",
      "title": "Contributing to Docs",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/CONTRIBUTING.md"
    },
    {
      "description": "How to run rtl_buddy effectively from an AI agent, including local docs access, machine mode, log formats, and the recommended validation workflow.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/agents/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/agents/#local-docs-access",
          "slug": "local-docs-access",
          "title": "Local docs access",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/agents/local-docs-access.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/agents/#agent-skill-install",
          "slug": "agent-skill-install",
          "title": "Agent Skill Install",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/agents/agent-skill-install.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/agents/#always-use-machine-mode",
          "slug": "always-use-machine-mode",
          "title": "Always use machine mode",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/agents/always-use-machine-mode.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/agents/#log-file-locations",
          "slug": "log-file-locations",
          "title": "Log file locations",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/agents/log-file-locations.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/agents/#machine-mode-log-format",
          "slug": "machine-mode-log-format",
          "title": "Machine mode log format",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/agents/machine-mode-log-format.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/agents/#how-passfail-is-detected",
          "slug": "how-passfail-is-detected",
          "title": "How pass/fail is detected",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/agents/how-passfail-is-detected.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/agents/#spec-traceability-commands",
          "slug": "spec-traceability-commands",
          "title": "Spec traceability commands",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/agents/spec-traceability-commands.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/agents/#recommended-validation-workflow",
          "slug": "recommended-validation-workflow",
          "title": "Recommended validation workflow",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/agents/recommended-validation-workflow.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/agents/#exit-codes",
          "slug": "exit-codes",
          "title": "Exit codes",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/agents/exit-codes.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/agents/#version-checking",
          "slug": "version-checking",
          "title": "Version checking",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/agents/version-checking.md"
        }
      ],
      "slug": "agents",
      "title": "For Agents",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/agents.md"
    },
    {
      "description": "How to setup rtl-buddy tests to use cocotb. How are cocotb results reported.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/cocotb/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/cocotb/#prerequisites",
          "slug": "prerequisites",
          "title": "Prerequisites",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/cocotb/prerequisites.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/cocotb/#yaml-shape",
          "slug": "yaml-shape",
          "title": "YAML shape",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/cocotb/yaml-shape.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/cocotb/#passfail-detection",
          "slug": "passfail-detection",
          "title": "Pass/fail detection",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/cocotb/passfail-detection.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/cocotb/#testbench-field-reference",
          "slug": "testbench-field-reference",
          "title": "Testbench field reference",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/cocotb/testbench-field-reference.md"
        }
      ],
      "slug": "concepts/cocotb",
      "title": "cocotb testbenches (Verilator + VPI)",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/concepts/cocotb.md"
    },
    {
      "description": "How to collect, merge, and report coverage for Verilator-based builds using rtl_buddy.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/coverage/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/coverage/#setup",
          "slug": "setup",
          "title": "Setup",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/coverage/setup.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/coverage/#coverage-merge-modes",
          "slug": "coverage-merge-modes",
          "title": "Coverage merge modes",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/coverage/coverage-merge-modes.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/coverage/#generating-merged-output",
          "slug": "generating-merged-output",
          "title": "Generating merged output",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/coverage/generating-merged-output.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/coverage/#directory-level-coverage-summary",
          "slug": "directory-level-coverage-summary",
          "title": "Directory-level coverage summary",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/coverage/directory-level-coverage-summary.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/coverage/#full-flag-reference",
          "slug": "full-flag-reference",
          "title": "Full flag reference",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/coverage/full-flag-reference.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/coverage/#full-schema",
          "slug": "full-schema",
          "title": "Full schema",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/coverage/full-schema.md"
        }
      ],
      "slug": "concepts/coverage",
      "title": "Coverage",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/concepts/coverage.md"
    },
    {
      "description": "How to extend rtl_buddy test behavior using sweep, preproc, and postproc Python plugin hooks.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/plugins/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/plugins/#sweep-expanding-one-test-into-many",
          "slug": "sweep-expanding-one-test-into-many",
          "title": "Sweep: expanding one test into many",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/plugins/sweep-expanding-one-test-into-many.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/plugins/#pre-processing-mutate-test-params-before-compile",
          "slug": "pre-processing-mutate-test-params-before-compile",
          "title": "Pre-processing: mutate test params before compile",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/plugins/pre-processing-mutate-test-params-before-compile.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/plugins/#post-processing",
          "slug": "post-processing",
          "title": "Post-processing",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/plugins/post-processing.md"
        }
      ],
      "slug": "concepts/plugins",
      "title": "Plugins",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/concepts/plugins.md"
    },
    {
      "description": "How to run multiple test suites in sequence using regression.yaml, filtering tests by regression level.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/regressions/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/regressions/#regression-config-regressionsyaml",
          "slug": "regression-config-regressionsyaml",
          "title": "Regression config: `regressions.yaml`",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/regressions/regression-config-regressionsyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/regressions/#running-a-regression",
          "slug": "running-a-regression",
          "title": "Running a regression",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/regressions/running-a-regression.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/regressions/#working-directory-behavior",
          "slug": "working-directory-behavior",
          "title": "Working directory behavior",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/regressions/working-directory-behavior.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/regressions/#full-schema",
          "slug": "full-schema",
          "title": "Full schema",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/regressions/full-schema.md"
        }
      ],
      "slug": "concepts/regressions",
      "title": "Regressions",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/concepts/regressions.md"
    },
    {
      "description": "How root_config.yaml configures platform selection, builders, and simulation settings for an RTL project.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/root-config/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/root-config/#location",
          "slug": "location",
          "title": "Location",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/root-config/location.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/root-config/#structure",
          "slug": "structure",
          "title": "Structure",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/root-config/structure.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/root-config/#key-fields",
          "slug": "key-fields",
          "title": "Key fields",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/root-config/key-fields.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/root-config/#builder-and-mode-overrides",
          "slug": "builder-and-mode-overrides",
          "title": "Builder and mode overrides",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/root-config/builder-and-mode-overrides.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/root-config/#full-schema",
          "slug": "full-schema",
          "title": "Full schema",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/root-config/full-schema.md"
        }
      ],
      "slug": "concepts/root-config",
      "title": "Root Config",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/concepts/root-config.md"
    },
    {
      "description": "How to use specs.yaml, models.yaml spec pointers, and tests.yaml covers fields to trace functional requirements through to tests.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/spec-traceability/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/spec-traceability/#workflow",
          "slug": "workflow",
          "title": "Workflow",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/spec-traceability/workflow.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/spec-traceability/#multi-block-specsyaml",
          "slug": "multi-block-specsyaml",
          "title": "Multi-block specs.yaml",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/spec-traceability/multi-block-specsyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/spec-traceability/#command-reference",
          "slug": "command-reference",
          "title": "Command reference",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/spec-traceability/command-reference.md"
        }
      ],
      "slug": "concepts/spec-traceability",
      "title": "Spec Traceability",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/concepts/spec-traceability.md"
    },
    {
      "description": "How to run synthesis flows with rtl_buddy using synth.yaml, cfg-synth-tools, cfg-synth-libs, and the rb synth command.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/synthesis/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/synthesis/#supported-backends",
          "slug": "supported-backends",
          "title": "Supported backends",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/synthesis/supported-backends.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/synthesis/#installing-yosys",
          "slug": "installing-yosys",
          "title": "Installing Yosys",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/synthesis/installing-yosys.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/synthesis/#installing-openroad",
          "slug": "installing-openroad",
          "title": "Installing OpenROAD",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/synthesis/installing-openroad.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/synthesis/#synthesis-config-synthyaml",
          "slug": "synthesis-config-synthyaml",
          "title": "Synthesis config: `synth.yaml`",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/synthesis/synthesis-config-synthyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/synthesis/#root-config-rootconfigyaml",
          "slug": "root-config-rootconfigyaml",
          "title": "Root config: `root_config.yaml`",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/synthesis/root-config-rootconfigyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/synthesis/#synthesis-regression-synthregressionyaml",
          "slug": "synthesis-regression-synthregressionyaml",
          "title": "Synthesis regression: `synth_regression.yaml`",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/synthesis/synthesis-regression-synthregressionyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/synthesis/#running-synthesis",
          "slug": "running-synthesis",
          "title": "Running synthesis",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/synthesis/running-synthesis.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/synthesis/#results-table",
          "slug": "results-table",
          "title": "Results table",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/synthesis/results-table.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/synthesis/#artefacts",
          "slug": "artefacts",
          "title": "Artefacts",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/synthesis/artefacts.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/synthesis/#passfail-detection",
          "slug": "passfail-detection",
          "title": "Pass/fail detection",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/synthesis/passfail-detection.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/synthesis/#full-schema",
          "slug": "full-schema",
          "title": "Full schema",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/synthesis/full-schema.md"
        }
      ],
      "slug": "concepts/synthesis",
      "title": "Synthesis",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/concepts/synthesis.md"
    },
    {
      "description": "How to define testbenches and tests in tests.yaml for a verification suite.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/tests/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/tests/#test-config-testsyaml",
          "slug": "test-config-testsyaml",
          "title": "Test config: `tests.yaml`",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/tests/test-config-testsyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/tests/#running-tests",
          "slug": "running-tests",
          "title": "Running tests",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/tests/running-tests.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/tests/#randomization",
          "slug": "randomization",
          "title": "Randomization",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/tests/randomization.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/tests/#logging",
          "slug": "logging",
          "title": "Logging",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/tests/logging.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/tests/#path-and-working-directory",
          "slug": "path-and-working-directory",
          "title": "Path and working directory",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/tests/path-and-working-directory.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/tests/#full-schema",
          "slug": "full-schema",
          "title": "Full schema",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/tests/full-schema.md"
        }
      ],
      "slug": "concepts/tests",
      "title": "Tests",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/concepts/tests.md"
    },
    {
      "description": "How rb wave opens Surfer with live signal value annotation in your editor via the WCP protocol.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/wave/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/wave/#basic-usage",
          "slug": "basic-usage",
          "title": "Basic usage",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/wave/basic-usage.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/wave/#configuration",
          "slug": "configuration",
          "title": "Configuration",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/wave/configuration.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/wave/#signal-value-annotation",
          "slug": "signal-value-annotation",
          "title": "Signal value annotation",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/wave/signal-value-annotation.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/concepts/wave/#surfer-build",
          "slug": "surfer-build",
          "title": "Surfer build",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/concepts/wave/surfer-build.md"
        }
      ],
      "slug": "concepts/wave",
      "title": "Waveform Viewer (`rb wave`)",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/concepts/wave.md"
    },
    {
      "description": "RTL Buddy is a Python CLI for Verilog and SystemVerilog regression testing, Verilator and VCS simulation workflows, Yosys synthesis flows, coverage, and YAML-based RTL automation.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/#features",
          "slug": "features",
          "title": "Features",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/index/features.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/#systemverilog-regression-testing",
          "slug": "systemverilog-regression-testing",
          "title": "SystemVerilog Regression Testing",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/index/systemverilog-regression-testing.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/#verilator-and-vcs-simulation-workflows",
          "slug": "verilator-and-vcs-simulation-workflows",
          "title": "Verilator and VCS Simulation Workflows",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/index/verilator-and-vcs-simulation-workflows.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/#yosys-synthesis-workflows",
          "slug": "yosys-synthesis-workflows",
          "title": "Yosys Synthesis Workflows",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/index/yosys-synthesis-workflows.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/#getting-started",
          "slug": "getting-started",
          "title": "Getting Started",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/index/getting-started.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/#reference",
          "slug": "reference",
          "title": "Reference",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/index/reference.md"
        }
      ],
      "slug": "index",
      "title": "RTL Buddy",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/index.md"
    },
    {
      "description": "How to install rtl_buddy into a project using uv, including prerequisites and verification steps.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/install/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/install/#prerequisites",
          "slug": "prerequisites",
          "title": "Prerequisites",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/install/prerequisites.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/install/#install-into-a-project-with-uv",
          "slug": "install-into-a-project-with-uv",
          "title": "Install Into A Project With `uv`",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/install/install-into-a-project-with-uv.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/install/#updating",
          "slug": "updating",
          "title": "Updating",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/install/updating.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/install/#installing-a-pre-release",
          "slug": "installing-a-pre-release",
          "title": "Installing A Pre-release",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/install/installing-a-pre-release.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/install/#set-up-the-agent-skill",
          "slug": "set-up-the-agent-skill",
          "title": "Set Up The Agent Skill",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/install/set-up-the-agent-skill.md"
        }
      ],
      "slug": "install",
      "title": "Installation",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/install.md"
    },
    {
      "description": "Known issues with rtl_buddy and workarounds for simulator-specific behaviors.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/known-issues/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/known-issues/#instance-prng-seeding-with-verilator",
          "slug": "instance-prng-seeding-with-verilator",
          "title": "Instance pRNG seeding with Verilator",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/known-issues/instance-prng-seeding-with-verilator.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/known-issues/#vcs-hierarchical-seed-file",
          "slug": "vcs-hierarchical-seed-file",
          "title": "VCS hierarchical seed file",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/known-issues/vcs-hierarchical-seed-file.md"
        }
      ],
      "slug": "known-issues",
      "title": "Known Issues",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/known-issues.md"
    },
    {
      "description": "How to migrate an RTL project from the legacy rtl_buddy submodule flow to a uv-managed PyPI dependency.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/migrations/submodule-to-uv/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/migrations/submodule-to-uv/#existing-state-before-migration",
          "slug": "existing-state-before-migration",
          "title": "Existing state before migration",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/migrations/submodule-to-uv/existing-state-before-migration.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/migrations/submodule-to-uv/#new-state-after-migration",
          "slug": "new-state-after-migration",
          "title": "New state after migration",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/migrations/submodule-to-uv/new-state-after-migration.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/migrations/submodule-to-uv/#migration-guide",
          "slug": "migration-guide",
          "title": "Migration guide",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/migrations/submodule-to-uv/migration-guide.md"
        }
      ],
      "slug": "migrations/submodule-to-uv",
      "title": "Migrating from Submodule to uv",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/migrations/submodule-to-uv.md"
    },
    {
      "description": "How to migrate an rtl_buddy project from v2 to v3, covering the artifact layout change and other breaking changes.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/migrations/v2-to-v3/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/migrations/v2-to-v3/#artifact-layout-change",
          "slug": "artifact-layout-change",
          "title": "Artifact layout change",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/migrations/v2-to-v3/artifact-layout-change.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/migrations/v2-to-v3/#what-to-update",
          "slug": "what-to-update",
          "title": "What to update",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/migrations/v2-to-v3/what-to-update.md"
        }
      ],
      "slug": "migrations/v2-to-v3",
      "title": "Migrating from v2 to v3",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/migrations/v2-to-v3.md"
    },
    {
      "description": "Run your first rtl_buddy test, regression, synthesis, and supporting commands in an already-installed project.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/quickstart/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/quickstart/#run-a-test",
          "slug": "run-a-test",
          "title": "Run a test",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/quickstart/run-a-test.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/quickstart/#run-a-regression",
          "slug": "run-a-regression",
          "title": "Run a regression",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/quickstart/run-a-regression.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/quickstart/#run-synthesis",
          "slug": "run-synthesis",
          "title": "Run synthesis",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/quickstart/run-synthesis.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/quickstart/#run-with-randomization",
          "slug": "run-with-randomization",
          "title": "Run with randomization",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/quickstart/run-with-randomization.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/quickstart/#check-logs",
          "slug": "check-logs",
          "title": "Check logs",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/quickstart/check-logs.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/quickstart/#next-steps",
          "slug": "next-steps",
          "title": "Next steps",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/quickstart/next-steps.md"
        }
      ],
      "slug": "quickstart",
      "title": "Quick Start",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/quickstart.md"
    },
    {
      "description": "Auto-generated CLI reference for all rtl-buddy commands and their options.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/cli/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/cli/#rtl-buddy",
          "slug": "rtl-buddy",
          "title": "rtl-buddy",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/cli/rtl-buddy.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/cli/#test",
          "slug": "test",
          "title": "test",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/cli/test.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/cli/#randtest",
          "slug": "randtest",
          "title": "randtest",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/cli/randtest.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/cli/#regression",
          "slug": "regression",
          "title": "regression",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/cli/regression.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/cli/#filelist",
          "slug": "filelist",
          "title": "filelist",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/cli/filelist.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/cli/#verible",
          "slug": "verible",
          "title": "verible",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/cli/verible.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/cli/#wave",
          "slug": "wave",
          "title": "wave",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/cli/wave.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/cli/#wave-install-nvim",
          "slug": "wave-install-nvim",
          "title": "wave-install-nvim",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/cli/wave-install-nvim.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/cli/#skill",
          "slug": "skill",
          "title": "skill",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/cli/skill.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/cli/#docs",
          "slug": "docs",
          "title": "docs",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/cli/docs.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/cli/#spec",
          "slug": "spec",
          "title": "spec",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/cli/spec.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/cli/#synth",
          "slug": "synth",
          "title": "synth",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/cli/synth.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/cli/#synth-regression",
          "slug": "synth-regression",
          "title": "synth-regression",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/cli/synth-regression.md"
        }
      ],
      "slug": "reference/cli",
      "title": "CLI Reference",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/reference/cli.md"
    },
    {
      "description": "Canonical reference for rtl_buddy YAML configuration files, including root_config.yaml, regression.yaml, tests.yaml, models.yaml, synth.yaml, synth_regression.yaml, cdc.yaml, and cdc_regression.yaml.",
      "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/yaml/",
      "sections": [
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/yaml/#rootconfigyaml",
          "slug": "rootconfigyaml",
          "title": "root_config.yaml",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/yaml/rootconfigyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/yaml/#regressionyaml",
          "slug": "regressionyaml",
          "title": "regression.yaml",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/yaml/regressionyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/yaml/#modelsyaml",
          "slug": "modelsyaml",
          "title": "models.yaml",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/yaml/modelsyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/yaml/#testsyaml",
          "slug": "testsyaml",
          "title": "tests.yaml",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/yaml/testsyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/yaml/#path-semantics-and-cwd",
          "slug": "path-semantics-and-cwd",
          "title": "Path semantics and cwd",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/yaml/path-semantics-and-cwd.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/yaml/#synthyaml",
          "slug": "synthyaml",
          "title": "synth.yaml",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/yaml/synthyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/yaml/#synthregressionyaml",
          "slug": "synthregressionyaml",
          "title": "synth_regression.yaml",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/yaml/synthregressionyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/yaml/#cdcyaml",
          "slug": "cdcyaml",
          "title": "cdc.yaml",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/yaml/cdcyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/yaml/#cdcregressionyaml",
          "slug": "cdcregressionyaml",
          "title": "cdc_regression.yaml",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/yaml/cdcregressionyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/yaml/#specsyaml",
          "slug": "specsyaml",
          "title": "specs.yaml",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/yaml/specsyaml.md"
        },
        {
          "human_url": "https://rtl-buddy.github.io/rtl_buddy/v3/reference/yaml/#authoring-checklist-for-new-suites",
          "slug": "authoring-checklist-for-new-suites",
          "title": "Authoring checklist for new suites",
          "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/sections/reference/yaml/authoring-checklist-for-new-suites.md"
        }
      ],
      "slug": "reference/yaml",
      "title": "YAML Formats",
      "url": "https://rtl-buddy.github.io/rtl_buddy/v3/agent/pages/reference/yaml.md"
    }
  ],
  "rtl_buddy_version": "v3",
  "schema_version": 1
}
