docs: polish intro, readme, and changelog for v0.1.0

Author: CameronBrooks11

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## v0.1.0
+
+- Initial public release of the simulation library.
+- Docs site with per-simulation pages and schematic renders.
+- Download bundles for PDFs and a full kit (PDF + KiCad + README).

README.md

@@ -1,13 +1,24 @@
-# KiCad-Simulation-Example
+# KiCad Simulation Examples
 
-## Introduction
+## Overview
 
-This collection of schematic circuits are used as examples by me when teaching my students. They are all ready for easy simulation, with all necessary SPICE-models included. Some circuits are using built-in generic models. There is a PDF of the schematic for each of the circuits, in case you only want the schematic circuit.
+This repository contains a curated set of KiCad schematics used to teach and explore circuit
+simulation concepts. Each simulation includes a short explanation and is ready to run in
+KiCad with included SPICE models where needed.
 
-## Simulation
+Docs site: https://feastorg.github.io/KiCad-Simulation-Examples/
 
-To do a simulation, you access the "Simulate circuit in SPICE" button in the Schematic Editor. Then access "Run/Stop Simulation" button in the "Spice Simulator" window. To show other signals that is set up, you must access the "Add Signals" or "Probe" button. Commands for the simulator are placed just above the title field in the schematic.
+Download bundles:
 
-## Engineering
+- PDFs only: https://feastorg.github.io/KiCad-Simulation-Examples/assets/downloads/schematics-pdf.zip
+- Full kit (PDF + KiCad schematic + README): https://feastorg.github.io/KiCad-Simulation-Examples/assets/downloads/schematics-kit.zip
+
+## How To Run a Simulation
+
+1. Open the `.kicad_sch` file for a simulation in KiCad.
+2. Click **Simulate** to open the simulator.
+3. Run the configured analysis and add probes/signals to plot results.
+
+## Tools
 
 The schematics are made with [KiCad](https://en.wikipedia.org/wiki/KiCad).

docs/README.md

@@ -1,3 +1,7 @@
 # Docs
 
-This is where the docs are kept!
+This folder contains the source for the GitHub Pages site.
+
+- `index.md` is generated and lists all simulations.
+- `introduction-to-simulations.md` provides a short KiCad simulation primer.
+- `contributing.md` describes the minimal structure required for a new simulation.

docs/contributing.md

@@ -2,7 +2,7 @@
 layout: default
 title: Contributing a Simulation
 parent: KiCad Simulation Examples
-nav_order: 3
+nav_order: 4
 ---
 
 Thanks for helping expand the KiCad Simulation Examples library. This site is built directly

docs/introduction-to-simulations.md

@@ -1,3 +1,45 @@
-# Introduction to Simulation in KiCad
+---
+layout: default
+title: Introduction to Simulation in KiCad
+parent: KiCad Simulation Examples
+nav_order: 2
+---
 
-Placeholder...check back later!
+KiCad includes an embedded circuit simulator that uses ngspice as its simulation engine and
+exposes simulation through the schematic editor UI. You build a simulation schematic, assign
+models to symbols, and run analyses to plot results.
+
+## What KiCad’s Simulator Is
+
+- **A graphical front end to ngspice**: KiCad integrates the open‑source ngspice engine and
+  provides simulation tools directly in the schematic editor.
+- **Schematic‑driven**: You can run simulations from standard KiCad schematics once models
+  are assigned and simulation directives are configured.
+
+## Core Analysis Types
+
+KiCad’s simulator exposes the standard ngspice analysis modes most commonly used in
+teaching and design:
+
+- **Operating Point (OP)**
+- **DC Sweep / DC Transfer**
+- **AC Sweep**
+- **Transient**
+
+Custom analysis directives are also supported for advanced use cases.
+
+## Practical Tips and Common Pitfalls
+
+- **Assign models before running**: KiCad ships SPICE‑oriented symbols, but you still need
+  to attach appropriate SPICE models for many devices.
+- **Use probes or save settings**: If you don’t save all voltages/currents, you must probe
+  or explicitly save the signals you want to plot.
+- **Bring your own third‑party models**: KiCad doesn’t bundle commercial SPICE libraries,
+  but you can use manufacturer‑supplied models.
+
+## References
+
+- KiCad Simulation (official overview):
+  - https://www.kicad.org/discover/spice/
+- ngspice User’s Manual:
+  - http://ngspice.sourceforge.net/docs/ngspice-manual.pdf

scripts/generate_sim_pages.py

@@ -83,7 +83,7 @@ def render_sim_index(items: list[tuple[str, str, str]]) -> str:
         f"title: {SIM_SECTION_TITLE}",
         f"parent: {SITE_TITLE}",
         "has_children: true",
-        "nav_order: 2",
+        "nav_order: 3",
         "---",
         "",
         "<!-- AUTO-GENERATED: DO NOT EDIT BY HAND -->",