From 08a4746ac95456f70bcc020c4d9a2ca5ceb9a218 Mon Sep 17 00:00:00 2001 From: Rohan Kumar Date: Sun, 28 Jun 2026 13:37:09 -0700 Subject: [PATCH 1/2] fix documentation and examples --- .../docs/getting-started/inverter/assets/index.md | 2 -- docs/docusaurus/docs/getting-started/quickstart.md | 7 ++----- .../getting-started/inverter/assets/index.md | 2 -- .../version-release/getting-started/quickstart.md | 2 +- examples/latest/sky130_inverter/src/tb/cds.rs | 2 -- examples/release/sky130_inverter/src/tb/cds.rs | 8 +++----- 6 files changed, 6 insertions(+), 17 deletions(-) diff --git a/docs/docusaurus/docs/getting-started/inverter/assets/index.md b/docs/docusaurus/docs/getting-started/inverter/assets/index.md index d2bec48f2..5b6326774 100644 --- a/docs/docusaurus/docs/getting-started/inverter/assets/index.md +++ b/docs/docusaurus/docs/getting-started/inverter/assets/index.md @@ -26,13 +26,11 @@ Ensure that you have the [protocol buffer compiler](https://grpc.io/docs/protoc- ### Rust Ensure that you have a recent version of Rust installed. -{ isRelease("{{VERSION}}") ?
Add the Substrate registry to your Cargo config: You only need to do this the first time you set up Substrate. -
:
} ### Project Setup diff --git a/docs/docusaurus/docs/getting-started/quickstart.md b/docs/docusaurus/docs/getting-started/quickstart.md index 5f42e04b7..59d83383b 100644 --- a/docs/docusaurus/docs/getting-started/quickstart.md +++ b/docs/docusaurus/docs/getting-started/quickstart.md @@ -23,15 +23,12 @@ Ensure that you have version 1.80.0 or beyond. Also ensure that you have the [protocol buffer compiler](https://grpc.io/docs/protoc-installation/) (`protoc`) installed. -{ isRelease("{{VERSION}}") ?
-First, add the Substrate registry to your Cargo config: +Then, add the Substrate registry to your Cargo config: You only need to do this the first time you set up Substrate. -
:
} - Next, create a new Rust project: ```bash @@ -70,7 +67,7 @@ We now define the schematic of the voltage divider. We can now write a Rust unit test to write the netlist to a file. -{vdividerMod} +{vdividerMod} To run the test, run diff --git a/docs/docusaurus/versioned_docs/version-release/getting-started/inverter/assets/index.md b/docs/docusaurus/versioned_docs/version-release/getting-started/inverter/assets/index.md index d2bec48f2..5b6326774 100644 --- a/docs/docusaurus/versioned_docs/version-release/getting-started/inverter/assets/index.md +++ b/docs/docusaurus/versioned_docs/version-release/getting-started/inverter/assets/index.md @@ -26,13 +26,11 @@ Ensure that you have the [protocol buffer compiler](https://grpc.io/docs/protoc- ### Rust Ensure that you have a recent version of Rust installed. -{ isRelease("{{VERSION}}") ?
Add the Substrate registry to your Cargo config: You only need to do this the first time you set up Substrate. -
:
} ### Project Setup diff --git a/docs/docusaurus/versioned_docs/version-release/getting-started/quickstart.md b/docs/docusaurus/versioned_docs/version-release/getting-started/quickstart.md index 38fd0a85f..59d83383b 100644 --- a/docs/docusaurus/versioned_docs/version-release/getting-started/quickstart.md +++ b/docs/docusaurus/versioned_docs/version-release/getting-started/quickstart.md @@ -67,7 +67,7 @@ We now define the schematic of the voltage divider. We can now write a Rust unit test to write the netlist to a file. -{vdividerMod} +{vdividerMod} To run the test, run diff --git a/examples/latest/sky130_inverter/src/tb/cds.rs b/examples/latest/sky130_inverter/src/tb/cds.rs index c37230627..be1f49ed3 100644 --- a/examples/latest/sky130_inverter/src/tb/cds.rs +++ b/examples/latest/sky130_inverter/src/tb/cds.rs @@ -29,8 +29,6 @@ use substrate::types::{Signal, TestbenchIo}; #[allow(dead_code)] mod schematic_only_tb { - use sky130::Sky130CdsSchema; - use super::*; // begin-code-snippet schematic-tb diff --git a/examples/release/sky130_inverter/src/tb/cds.rs b/examples/release/sky130_inverter/src/tb/cds.rs index c37230627..abff8e87f 100644 --- a/examples/release/sky130_inverter/src/tb/cds.rs +++ b/examples/release/sky130_inverter/src/tb/cds.rs @@ -5,15 +5,15 @@ use crate::InverterIoKind; use quantus::pex::Pex; use rust_decimal::prelude::ToPrimitive; use rust_decimal_macros::dec; -use sky130::Sky130CdsSchema; use sky130::corner::Sky130Corner; use sky130::layout::to_gds; use sky130::sky130_lvs; use sky130::sky130_lvs_rules_path; use sky130::sky130_technology_dir; -use spectre::Spectre; +use sky130::Sky130CdsSchema; use spectre::analysis::tran::Tran; use spectre::blocks::{Pulse, Vsource}; +use spectre::Spectre; use spice::Spice; use std::path::Path; use std::sync::Arc; @@ -21,16 +21,14 @@ use substrate::block::Block; use substrate::context::Context; use substrate::error::Result; use substrate::schematic::{CellBuilder, ConvertSchema, Schematic}; -use substrate::simulation::Pvt; use substrate::simulation::waveform::{EdgeDir, TimeWaveform}; +use substrate::simulation::Pvt; use substrate::types::schematic::{IoNodeBundle, Node}; use substrate::types::{Signal, TestbenchIo}; // end-code-snippet imports #[allow(dead_code)] mod schematic_only_tb { - use sky130::Sky130CdsSchema; - use super::*; // begin-code-snippet schematic-tb From b56bdceb9100ee8994397ac751c5994262448ed2 Mon Sep 17 00:00:00 2001 From: Rohan Kumar Date: Sun, 28 Jun 2026 13:46:15 -0700 Subject: [PATCH 2/2] fix fmt --- examples/release/sky130_inverter/src/tb/cds.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/release/sky130_inverter/src/tb/cds.rs b/examples/release/sky130_inverter/src/tb/cds.rs index abff8e87f..be1f49ed3 100644 --- a/examples/release/sky130_inverter/src/tb/cds.rs +++ b/examples/release/sky130_inverter/src/tb/cds.rs @@ -5,15 +5,15 @@ use crate::InverterIoKind; use quantus::pex::Pex; use rust_decimal::prelude::ToPrimitive; use rust_decimal_macros::dec; +use sky130::Sky130CdsSchema; use sky130::corner::Sky130Corner; use sky130::layout::to_gds; use sky130::sky130_lvs; use sky130::sky130_lvs_rules_path; use sky130::sky130_technology_dir; -use sky130::Sky130CdsSchema; +use spectre::Spectre; use spectre::analysis::tran::Tran; use spectre::blocks::{Pulse, Vsource}; -use spectre::Spectre; use spice::Spice; use std::path::Path; use std::sync::Arc; @@ -21,8 +21,8 @@ use substrate::block::Block; use substrate::context::Context; use substrate::error::Result; use substrate::schematic::{CellBuilder, ConvertSchema, Schematic}; -use substrate::simulation::waveform::{EdgeDir, TimeWaveform}; use substrate::simulation::Pvt; +use substrate::simulation::waveform::{EdgeDir, TimeWaveform}; use substrate::types::schematic::{IoNodeBundle, Node}; use substrate::types::{Signal, TestbenchIo}; // end-code-snippet imports