diff --git a/docs/_assets/images/favicon.ico b/docs/_assets/images/favicon.ico new file mode 100644 index 00000000..bf365cda Binary files /dev/null and b/docs/_assets/images/favicon.ico differ diff --git a/docs/_assets/images/picture.png b/docs/_assets/images/picture.png deleted file mode 100644 index d15aced7..00000000 Binary files a/docs/_assets/images/picture.png and /dev/null differ diff --git a/docs/_assets/images/rasterchef.ico b/docs/_assets/images/rasterchef.ico deleted file mode 100644 index 8a4afa8e..00000000 Binary files a/docs/_assets/images/rasterchef.ico and /dev/null differ diff --git a/docs/_config.yml b/docs/_config.yml index 327ae317..e605894b 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -28,6 +28,8 @@ url: "https://ut.ieee.ras.github.io" # the base hostname & protocol for your sit # Build settings theme: just-the-docs +favicon_ico: "/_assets/images/favicon.ico" + livereload: true search_enabled: true diff --git a/docs/_sections/_guide-general/schedule.md b/docs/_sections/_guide-general/schedule.md index 050c7b70..60a5fe45 100644 --- a/docs/_sections/_guide-general/schedule.md +++ b/docs/_sections/_guide-general/schedule.md @@ -5,6 +5,27 @@ nav_include: true nav_order: 2 --- -TODO: put real calendar here +# TODO: Integrate office hours into the calendar shown here? + - \ No newline at end of file +## Dates List: + +**Moving Base Checkpoint** - Oct 6 + +**Solidworks Workshop** - Oct 7 + +**Line/Wall/Color Checkpoint** - Oct 13 + +**Breadboarding Workshop** - Oct 14 + +**Line/Wall/Color Checkpoint** - Oct 20 + +**Color Sensor Workshop** - Oct 21 + +**Line/Wall Follow Workshop** - Oct 28 + +**Mechanical Design Checkpoint** - Nov 3 + +**Line/Wall/Color Checkpoint** - Nov 10 + +**Competition Day** - Nov 16 diff --git a/docs/_sections/_guide-primaries/checkpoints/checkpoints.md b/docs/_sections/_guide-primaries/checkpoints/checkpoints.md new file mode 100644 index 00000000..6a8f7c40 --- /dev/null +++ b/docs/_sections/_guide-primaries/checkpoints/checkpoints.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Checkpoints +nav_include: true +has_children: true +nav_order: 5 +--- \ No newline at end of file diff --git a/docs/_sections/_guide-primaries/checkpoints/color-checkpoint.md b/docs/_sections/_guide-primaries/checkpoints/color-checkpoint.md new file mode 100644 index 00000000..cf445eb6 --- /dev/null +++ b/docs/_sections/_guide-primaries/checkpoints/color-checkpoint.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Color Checkpoint +nav_include: true +parent: Checkpoints +nav_order: 3 +--- \ No newline at end of file diff --git a/docs/_sections/_guide-primaries/checkpoints/line-checkpoint.md b/docs/_sections/_guide-primaries/checkpoints/line-checkpoint.md new file mode 100644 index 00000000..7b90db21 --- /dev/null +++ b/docs/_sections/_guide-primaries/checkpoints/line-checkpoint.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Line Checkpoint +nav_include: true +parent: Checkpoints +nav_order: 1 +--- \ No newline at end of file diff --git a/docs/_sections/_guide-primaries/checkpoints/wall-checkpoint.md b/docs/_sections/_guide-primaries/checkpoints/wall-checkpoint.md new file mode 100644 index 00000000..989877ba --- /dev/null +++ b/docs/_sections/_guide-primaries/checkpoints/wall-checkpoint.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Wall Checkpoint +nav_include: true +parent: Checkpoints +nav_order: 2 +--- \ No newline at end of file diff --git a/docs/_sections/_guide-primaries/getting-started/reading-datasheets.md b/docs/_sections/_guide-primaries/getting-started/reading-datasheets.md index 5b779c14..ec8803cf 100644 --- a/docs/_sections/_guide-primaries/getting-started/reading-datasheets.md +++ b/docs/_sections/_guide-primaries/getting-started/reading-datasheets.md @@ -11,7 +11,7 @@ The internet! Textbooks! How-to guides! Datasheets are yet another form of refer Datasheets help you understand the component better- whether it’s increasing accuracy or troubleshooting mistakes. For now, don’t worry if you can’t understand everything written in those pages. The topics addressed on this page are the most relevant for Robotathon. -[Here is a link](https://www.infineon.com/dgdl/Infineon-IPP055N03L-DS-v01_03-en.pdf?fileId=db3a30431441fb5d01148d01ee1c0e91) to the datasheet this page references below. This component is **not** used in Robotathon, but it makes a good dissection example. +[Here is a link](https://www.infineon.com/dgdl/Infineon-IPP055N03L-DS-v01_03-en.pdf?fileId=db3a30431441fb5d01148d01ee1c0e91) to the datasheet this page references below. This component is **not** used in Robotathon, but it makes for a good example to dissect.
datasheet @@ -26,7 +26,6 @@ Typically, the first page is pretty meta. Areas of interest include: ## Specifications * Numbers that describe what a part needs and can do -**Check the Table of Contents (TOC) for or skim the pages for the following topics!** ## Connection Diagrams * A pinout lists the part’s pins, where they’re physically located, and their functions. diff --git a/docs/_sections/_guide-supplementals/glossary.md b/docs/_sections/_guide-supplementals/glossary.md new file mode 100644 index 00000000..3439b90a --- /dev/null +++ b/docs/_sections/_guide-supplementals/glossary.md @@ -0,0 +1,63 @@ +--- +layout: default +title: Glossary +nav_include: true +# parent: Resources +nav_order: 6 +--- + +**Abstracted:** When details have been simplified, hidden, or removed from your perspective or the task at hand. The purpose of abstraction is to make your tasks easier or more manageable in the Robotathon learning environment. + +**Algorithm:** In a software context, and algorithm is a systematic or step-by-step approach that guides the development of software or the implementation of certain functionalities. + +**Analog:**A type of signal usually represented by continuously varying PHYSICAL quantities such as voltage, current, or sound waves. + +**Binary:**A form of representation of data in the form of bits. Each bit can either hold the value 0 or 1. +**Breadboard:** A device used to create temporary electrical connections between components like resistors, LEDs, and wires without the need for soldering. + +**Bodge:** A temporary fix or workaround. + +**Bug Fixing:**The process of identifying and resolving issues or bugs in software or systems. When software is developed, it can contain errors or defects that cause unintended behavior or malfunctions. Bug fixing is the act of locating these issues and implementing solutions to rectify them. + +**Caster Ball:** A specialized wheel assembly designed for easy movement and rotation. + +**Chassis:**A chassis is a framework or structure that provides support and holds together various components of a larger system or device. It serves as a foundation or base on which other parts are mounted or attached. + +**Compile:**the process of converting source code written in a high-level programming language into a lower-level language or machine code that can be understood and executed by a computer. + +**Continuity Mode:**"Continuity mode" is a feature available on many multimeters, which is used to test for electrical continuity in a circuit. Continuity refers to the presence of a complete path for electric current to flow through a circuit without any breaks or interruptions. + +**Development Environment:** A development environment, also known as an integrated development environment (IDE), is a software application or platform that provides tools, features, and an interface to assist developers in writing, testing, and debugging software applications. It is a comprehensive environment designed to streamline the development process and enhance productivity. + +**Digital:** A digital signal is a type of signal that represents discrete values or states. It consists of a series of voltage or current levels that are encoded to represent binary digits (bits), typically using two distinct voltage levels or states. The two voltage levels are often referred to as "high" and "low," "1" and "0," or "on" and "off." + +**Flash:** Loading your programmed code onto the microcontroller. + +**Function:** A function is a named block of code that performs a specific task or a set of instructions. It is a fundamental concept in programming and is used to organize code into modular and reusable units. + +**GPIO:** Stands for General Purpose Input/Output.It is a common feature found on microcontrollers, single-board computers, and other embedded systems. GPIO pins provide a way to interface with external devices or circuits by providing input or receiving output signals. + +**Interfacing:** In the context of programming and electronics, "interfacing" refers to the process of connecting and communicating between different components or systems. It involves establishing a connection or interface that allows for the exchange of data, signals, or commands between the entities involved. + +**IR Sensor:** An IR (Infrared) sensor is a device that detects and responds to infrared radiation in its surrounding environment. It is commonly used for proximity sensing, object detection, and remote control applications. Infrared radiation is electromagnetic radiation with wavelengths longer than those of visible light, but shorter than radio waves. + +**I2C:** I2C (Inter-Integrated Circuit) is a serial communication protocol commonly used to enable communication between integrated circuits (ICs) or electronic components on a circuit board. It was developed by Philips Semiconductors (now NXP Semiconductors) and has become a widely adopted standard for communication between devices. + +**LED:** An LED (Light Emitting Diode) is a semiconductor device that emits light when an electric current passes through it. LEDs are widely used for various applications, including indicators, displays, lighting, and visual communication. + +**Line Sensor:** A line sensor, also known as a line follower sensor, is a device used to detect and follow lines or tracks on a surface. It is commonly used in robotics, particularly in line-following robots or automated systems where precise tracking along a specific path is required. + +**Motor:** A motor is a device that converts electrical energy into mechanical energy, allowing for the generation of motion or the application of force. Motors are widely used in various applications, from industrial machinery to consumer electronics, robotics, automotive systems, and more. + +**Multimeter:** A versatile electronic instrument used to measure various electrical quantities. + +**RGB Color Sensor:** An RGB color sensor is a device used to detect and measure the intensity of red, green, and blue light in order to determine the color of an object or surface. It can analyze the spectral components of light and provide data about the color composition. + +**RGB Color Space:** RGB color space is a color model used to represent colors by specifying their intensity values for the primary colors: red (R), green (G), and blue (B). It is widely used in digital imaging, computer graphics, and display technologies. + +**Servo Motor:** A servo motor is a type of motor that is specifically designed for precise control of angular position, velocity, and acceleration. + +**Short:** A short circuit occurs when a low-resistance path is unintentionally created between two points in an electri that are supposed to have different potentials (voltages). + +**SOLIDWORKS:** A computer-aided design (CAD) software package that is widely used for 3D modeling, simulation, and design documentation. It is developed by Dassault Systèmes and is renowned for its powerful capabilities and user-friendly interface. + diff --git a/docs/favicon.ico b/docs/favicon.ico deleted file mode 100644 index 8a4afa8e..00000000 Binary files a/docs/favicon.ico and /dev/null differ