test deployment

webpage/docs/00_getting_started/00_getting_started.md

@@ -0,0 +1,14 @@
+# ToDo
+
+- [ ] Introduction  
+- [ ] Getting Started with PCB Design  
+- [ ] Getting Started with KiCad  
+- [ ] Schematic Design  
+- [ ] Layout  
+- [ ] Design Principles and PCB Terms  
+- [ ] Design Workflow and Considerations  
+- [ ] Symbols and Eeschema  
+- [ ] Footprints and Pcbnew  
+- [ ] Project: Design a Simple Breadboard Power Supply PCB  
+- [ ] Project: MCU Datalogger with Built-in 512K EEPROM and Clock  
+- [ ] Recipes  

webpage/docs/00_getting_started/3_study-guide.md → webpage/docs/00_getting_started/03_study-guide.md

@@ -25,8 +25,6 @@ This part provides a **foundational introduction** to printed circuit boards (PC
 **Who should focus on this part?**  
 If you're new to PCB design, you should complete this section to ensure you have a solid grasp of the basic concepts before moving on to more complex tasks.
 
-
-
 ## Part 2: First Simple Hands-on Project
 
 ### Overview
@@ -57,8 +55,6 @@ The material in Part 3 is designed to be **reference content**—you don’t hav
 **Who should focus on this part?**  
 If you are new to PCB design, it's essential to watch these lectures after completing the hands-on project. If you're an experienced PCB designer but new to KiCad, you can jump directly to sections covering specific features of KiCad, such as the schematic editor or the PCB editor.
 
-
-
 ## Part 4: Project-Based Learning
 
 ### Overview
@@ -77,8 +73,6 @@ This part is the core of the course. It consists of **multiple hands-on projects
 **Who should focus on this part?**  
 Everyone should work through these projects. They are the best way to reinforce the knowledge from the reference sections and apply KiCad features in real-world scenarios. Beginners should complete the earlier projects before moving on to more complex designs, while experienced designers may start with more advanced projects.
 
-
-
 ## Part 5: Recipes and Specific How-to Guides
 
 ### Overview

webpage/docs/01_pcb_design/2_pcb-design-process.md → webpage/docs/01_pcb_design/02_pcb-design-process.md

@@ -10,8 +10,6 @@ Designing a PCB is quite different from PCB manufacturing. As a PCB designer, yo
 
 This course will guide you through the **KiCad PCB design workflow**, a model I've developed from experience and best practices in the field. You can follow this workflow or adapt it to suit your own preferences. The workflow is split into two primary steps: **schematic design** and **layout design**.
 
-
-
 ## High-Level PCB Design Workflow
 
 ### Step 1: Schematic Design
@@ -34,8 +32,6 @@ To create a physical layout of the PCB, including the placement of components, r
 **Tools Used:**
 - **PCBnew (KiCad's Layout Editor):** This is where you define the physical layout, place the components, and draw the traces that connect them.
 
-
-
 ## Detailed PCB Design Workflow
 
 Let’s break down the key steps in the PCB design process:
@@ -74,8 +70,6 @@ After your PCB passes the DRC, the final step is to export the design for manufa
 - **Drill Files:** A file that defines the locations and sizes of holes (vias, component holes) that need to be drilled.
 - **Bill of Materials (BOM):** A BOM file lists all components used in the design, including their part numbers, values, and footprints. This file is essential for ordering components from suppliers.
 
-
-
 ## PCB Design and Aesthetic Considerations
 
 Designing a PCB isn’t just about making the board functional; there is an artistic element to it as well. Over time, as you develop your skills, you’ll likely notice your boards taking on a personal aesthetic. Some designers focus on neat, symmetrical layouts, while others might prioritize compactness and minimalism. Here are some considerations that will help improve both the functionality and the visual appeal of your boards:
@@ -89,8 +83,6 @@ Aim for neat, orderly trace routing. Avoid sharp angles or long, looping traces.
 ### 3. **Silkscreen Clarity**
 Use silkscreen to clearly label components, pins, and any critical information that the end user might need. However, avoid over-cluttering the board. Use concise labels and make sure they are placed where they will be visible once the components are soldered.
 
-
-
 ## Key Terminology Recap
 
 Before moving on to the next lecture, here’s a recap of some important terms:
@@ -102,8 +94,6 @@ Before moving on to the next lecture, here’s a recap of some important terms:
 - **Silkscreen:** A printed layer on the PCB that provides information, such as component labels and logos, for assembly and usage.
 - **Gerber File:** The industry-standard file format used to send PCB designs to manufacturers for fabrication.
 
-
-
 ## Conclusion
 
 The PCB design process is both a technical and creative journey. You’ll follow a procedural workflow, but as you gain experience, you’ll develop your unique style. The two main stages—schematic design and PCB layout—are supported by powerful tools in KiCad, and this course will guide you through using these tools to create your own boards. Once your layout is complete and verified, you’ll be ready to send your design to a manufacturer for fabrication.

webpage/docs/01_pcb_design/3_manufacturing.md → webpage/docs/01_pcb_design/03_manufacturing.md

@@ -20,8 +20,6 @@ There are many PCB manufacturers around the world. China is home to some of the
 - **Oshpark:** Known for its simplicity, Oshpark is ideal for beginners. The ordering process is straightforward: you upload Gerber files (or sometimes KiCad PCB files directly), review the design in a user-friendly interface, and proceed with your order.
 - **PCBWay:** This manufacturer offers more customization options, making it suitable for more advanced users. You can adjust everything from the board material and thickness to hole sizes, solder mask colors, and more.
 
-
-
 ## How to Order a PCB from a Manufacturer
 
 ### Example 1: Ordering from Oshpark
@@ -38,8 +36,6 @@ PCBWay offers more extensive customization options, which are suitable for advan
 3. **Customize Further:** PCBWay lets you specify solder mask color, board thickness, minimum hole size, and more. You can adjust these settings to match your project’s requirements.
 4. **Get a Quote and Order:** PCBWay provides real-time pricing based on your customizations, starting from $5 for a basic two-layer PCB. You can then proceed to place your order.
 
-
-
 ## Understanding Gerber Files
 
 Gerber files are the industry standard for PCB manufacturing. These files contain all the data needed to fabricate your PCB, including the copper layers, solder mask, silkscreen, and drill information. When you finish your PCB layout in KiCad, you’ll export these Gerber files and send them to the manufacturer.
@@ -60,19 +56,15 @@ Each Gerber file corresponds to a different layer of the PCB:
 ### Gerber File Format
 Gerber files are defined by a company called Ucamco, and they have evolved over the years. KiCad currently supports the **Gerber X2 format**, which offers improvements over earlier versions. While the technical details of the Gerber format are not crucial for this course, it’s good to know that Gerber files are human-readable and can be opened with any text editor or specialized viewer.
 
-
-
 ## Verifying Gerber Files
 
 Before sending your Gerber files to a manufacturer, it’s a good idea to double-check them using a **Gerber viewer**. KiCad comes with a built-in Gerber viewer, which allows you to visually inspect the files and ensure that all layers are correctly aligned and free of errors.
 
 - **Load the Gerber Files:** Open your Gerber files in KiCad’s Gerber viewer or another external viewer.
 - **Inspect the Layers:** Review each layer (e.g., front copper, back copper) to ensure that everything looks correct. This step helps catch issues like missing traces, overlapping components, or incorrect drill locations.
 
-
-
 ## Conclusion
 
 When you’ve finished laying out your PCB, you have two main options for manufacturing: **DIY chemical etching** or **professional PCB manufacturing**. The DIY approach, while educational, is not recommended due to the risks and complexity involved. Instead, using a professional manufacturer is faster, safer, and often cheaper for small to medium-sized projects.
 
-You’ll typically use **Gerber files** to send your design to a manufacturer, but some manufacturers (like Oshpark) may also accept KiCad project files directly. By using manufacturers like Oshpark or PCBWay, you can create high-quality PCBs with minimal hassle, and as you gain experience, you’ll have access to more advanced customization options.
+You’ll typically use **Gerber files** to send your design to a manufacturer, but some manufacturers (like Oshpark) may also accept KiCad project files directly. By using manufacturers like Oshpark or PCBWay, you can create high-quality PCBs with minimal hassle, and as you gain experience, you’ll have access to more advanced customization options.

webpage/docs/01_pcb_design/4_example-project.md → webpage/docs/01_pcb_design/04_example-project.md

@@ -23,8 +23,6 @@ For this example, I’ve chosen the **PIC Programmer** project. The folder conta
 To open the project in KiCad:
 - You can **double-click the `.pro` file** or drag and drop it into the KiCad main window. This will open the project as a whole, allowing you to access both the schematic and PCB layout from within the same interface.
 
-
-
 ## Exploring the Schematic Editor (Eeschema)
 
 Once the project is open, you can start by exploring the **Schematic Editor**. In KiCad, this is known as **Eeschema**, and it’s where you’ll design the circuit itself.
@@ -76,24 +74,18 @@ One of the standout features of KiCad is the **3D Viewer**, which allows you to
 
 - **Opening the 3D Viewer:** Click the **3D Viewer** button on the top toolbar. The viewer provides a realistic view of your PCB, showing the components, silkscreen, and board outline.
 
-
-
 ## Integration Between Schematic and PCB Editors
 
 KiCad tightly integrates its **Schematic Editor** and **PCB Editor**, allowing you to easily navigate between the two environments:
 - **Cross-Referencing:** Clicking on a component in the schematic will automatically highlight the corresponding component in the PCB layout, and vice versa. For example, selecting a capacitor in the Schematic Editor will focus on that component in the PCB Editor.
 - **Real-Time Updates:** Any changes you make to the schematic, such as adding or removing components, will reflect in the PCB layout once the design is updated.
 
-
-
 ## Exploring More KiCad Projects
 
 While this course focuses on beginner-to-intermediate-level projects, KiCad is capable of handling much more complex designs. I encourage you to explore additional projects in the KiCad demo repository to see what’s possible. You can also visit KiCad’s **Made with KiCad** page to see real-world projects developed by engineers and hobbyists using the tool.
 
 Some projects demonstrate KiCad’s capabilities for high-density and high-complexity designs, far beyond the scope of this course. By reviewing these projects, you’ll gain a better understanding of how advanced users apply KiCad’s features in professional applications.
 
-
-
 ## Conclusion
 
 In this lecture, we explored two of KiCad’s most important applications: **Eeschema** (the Schematic Editor) and **PCBnew** (the PCB Layout Editor). We walked through the basics of opening and navigating a project, placing components, routing traces, and viewing the board in 3D. As you continue through this course, you’ll use these tools extensively to design your own projects, starting with simple circuits and gradually building up to more advanced layouts.

webpage/docs/02_kicad/1_introduction.md → webpage/docs/02_kicad/01_introduction.md

@@ -1,7 +1,3 @@
----
-sidebar_position: 1
----
-
 # Concepts, Best Practices, and Insights
 
 KiCad provides a suite of applications that help both beginner and advanced PCB designers move seamlessly from schematic capture to PCB layout and manufacturing. In this guide, we'll cover everything you need to know about KiCad’s key features, design principles, and best practices to get the most out of this software.
@@ -20,8 +16,6 @@ KiCad is an all-in-one open-source PCB design tool suite that supports everythin
 ### Target Audience
 KiCad caters to a wide range of users, from hobbyists to professional PCB designers. Its versatility and customization options make it suitable for small personal projects and complex professional designs.
 
-
-
 ## 2. Installation and Setup
 
 Before diving into the features and functionality of KiCad, ensure that it is installed on your computer. KiCad supports **macOS**, **Windows**, and **Linux** platforms.
@@ -65,8 +59,6 @@ This tool provides a 3D rendering of your PCB, showing how components will look
 ### 3.6. **Gerber Viewer**
 The Gerber Viewer is used to inspect the Gerber files generated for manufacturing. It allows you to visualize all layers of the PCB to ensure that they meet design and manufacturing requirements.
 
-
-
 ## 4. Key Libraries in KiCad
 
 KiCad relies heavily on libraries for components, footprints, and 3D models. Understanding these libraries and how to manage them is crucial for efficient PCB design.
@@ -83,8 +75,6 @@ These contain 3D representations of components that you can use to visualize the
 ### 4.4. **Template Libraries**
 Templates can be used as starting points for common PCB designs, helping speed up the creation of standard boards.
 
-
-
 ## 5. Creating Your First PCB: Step-by-Step
 
 ### 5.1. **Start a New Project**
@@ -110,8 +100,6 @@ Templates can be used as starting points for common PCB designs, helping speed u
 - Once the PCB layout is complete, generate Gerber files by going to `File` > `Plot`. These files will be sent to the manufacturer for production.
 - Use the **Gerber Viewer** to inspect your design before submitting it for manufacturing.
 
-
-
 ## 6. Best Practices for PCB Design in KiCad
 
 ### 6.1. **Design Rule Checks (DRC)**
@@ -132,8 +120,6 @@ Adding a ground plane can help reduce noise and improve signal integrity, especi
 - Keep your symbol and footprint libraries organized to ensure reusability across projects.
 - Regularly update libraries to ensure compatibility with the latest components.
 
-
-
 ## 7. Advanced Tips and Optimization
 
 ### 7.1. **Custom Footprints**
@@ -143,11 +129,4 @@ Create custom footprints when your project requires components with non-standard
 KiCad supports Python scripting, which can automate repetitive tasks such as generating BOMs or adjusting layout rules for large projects.
 
 ### 7.3. **Multi-Layer Designs**
-For complex designs, using multiple layers can simplify routing and reduce the size of the board. KiCad supports up to 32 copper layers.
-
-
-
-## 8. Conclusion
-
-KiCad is an incredibly powerful tool for PCB design, offering a wide range of features that can accommodate designs of varying complexity. By following the best practices outlined in this guide, you can streamline your design process and produce high-quality PCBs.
-
+For complex designs, using multiple layers can simplify routing and reduce the size of the board. KiCad supports up to 32 copper layers.

webpage/docs/02_kicad/2_project-manager.md → webpage/docs/02_kicad/02_project-manager.md

@@ -1,7 +1,3 @@
----
-sidebar_position: 2
----
-
 # Project Manager
 
 In this section, we delve into the **KiCad Project Manager**, the central hub for managing your PCB design projects. This guide will explain how the Project Manager operates, its interface, and how to utilize its tools effectively for intermediate and advanced PCB designers.
@@ -15,8 +11,6 @@ When you first open KiCad, the **Project Manager** is the main window you’ll s
 2. **File Management**: Displays project directories and allows easy access to manage your files directly.
 3. **Toolbar Functions**: Provides convenient actions like creating new projects, opening existing ones, refreshing the file view, and accessing project folders.
 
-
-
 ## Opening a KiCad Project
 
 Once KiCad is installed and running, loading a project is straightforward:
@@ -31,8 +25,6 @@ Once KiCad is installed and running, loading a project is straightforward:
 ### Demonstration Example:
 If you close a project, simply drag the project file back into the main window, or open it via the file menu to reload it.
 
-
-
 ## The KiCad Project Manager Interface
 
 Let’s break down the user interface of the **Project Manager**.
@@ -98,8 +90,6 @@ The **View** menu gives access to:
 #### Example:  
 You can manually edit a schematic’s text file to adjust component sizes or settings without opening the Schematic Editor. Any saved changes will reflect in the project.
 
-
-
 ## Tools Menu and Gerber Viewer
 
 From the **Tools** menu, you can launch all of KiCad’s applications, such as the **Gerber Viewer**:
@@ -133,7 +123,3 @@ KiCad’s **Help** menu provides access to local and online documentation:
 - **User Manual**: A comprehensive guide on using KiCad’s features.
 - **Getting Started Guide**: An introductory document to help you navigate through your first KiCad project.
 - **Hotkeys List**: A list of shortcuts for speeding up your workflow.
-
-## Conclusion
-
-The **KiCad Project Manager** is your primary interface for organizing and managing your PCB design workflow. By understanding its structure and tools, you can streamline your design process, improve efficiency, and enhance the quality of your PCB projects. In the upcoming sections, we will dive deeper into individual applications like the **Schematic Editor** and **PCB Editor**, explaining their advanced functionalities in detail.