An open API service indexing awesome lists of open source software.

https://github.com/cornellev/chassis-docs

A repository to store the documentation for things that we've learned over time.
https://github.com/cornellev/chassis-docs

documentation markdown obsidian

Last synced: about 1 month ago
JSON representation

A repository to store the documentation for things that we've learned over time.

Awesome Lists containing this project

README

          

# ![Logo](https://static.wixstatic.com/media/9bc36c_6b5947752da64f8fbfca0d30a0138f3a~mv2.png/v1/fill/w_30,h_62,al_c,q_85,usm_0.66_1.00_0.01,enc_avif,quality_auto/logolight.png) Chassis Documentation
#navigation

![Obsidian](https://img.shields.io/badge/Obsidian-%23483699.svg?style=for-the-badge&logo=obsidian&logoColor=white)
![Markdown](https://img.shields.io/badge/markdown-%23000000.svg?style=for-the-badge&logo=markdown&logoColor=white)
![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white)

**Cornell Electric Vehicles - Chassis Team Knowledgebase**

## 📋 Overview

Hello! Welcome to the **Cornell Electric Vehicles** *Chassis* subteam knowledge base. This serves as a centralized system for our team to build a connected mind-map of technical know-how that can be easily accessed.

This database uses [**Obsidian**](https://obsidian.md), an incredibly useful notes editor that makes organizing data extremely easy. You can read more on getting started with Obsidian below:

1. [Obsidian Help Documentation](https://help.obsidian.md/) - Official comprehensive guide to using Obsidian
2. [Obsidian for Beginners: Start HERE](https://obsidian.rocks/getting-started-with-obsidian-a-beginners-guide/) - Step-by-step beginner's guide

## 🔗 Quick Navigation (*Obsidian friendly links*)

### 🛠️ Technical Resources
- [Theory Index](vault/technical-index.md) - Central hub for all theoretical concepts and related documentation
- [Manufacturing Index](vault/manufacturing-index.md) - Hub for all manufacturing, including CNC and composite techniques.
- [Notes Index](vault/notes-index.md) - Source for any miscellaneous notes taken whenever, wherever.

### 👥 Knowledge Hubs by Team Member
- [Lucas](vault/lucas.md)
- [Ei](vault/ei.md)
- [Zach](vault/zach.md)
- [Joe](joe.md)
- [Ana](vault/ana.md)
- [Serkan](vault/serkan.md)
- [Yohanne](vault/yohanne.md)
- [Selena](vault/selena.md)

## Getting Started / Installation

1. **Install Obsidian** from [obsidian.md](https://obsidian.md/), or via [`homebrew`](https://brew.sh)
2. **Clone this repository**:
```bash
git clone https://github.com/cornellev/chassis-docs.git
```
3. **Open the folder** in Obsidian as a vault

## 🌿 Adding documentation (for current members)

> **NOTE**: All changes must be made in your specific branch. See instructions below:

1. **Create a branch with your name**: `git checkout -b feature/your-name`
2. **Make changes and commit when necessary**: `git commit -m "Add: descriptive message"`, then run `git push origin your-name`
3. **When ready, make a pull request to the `main` branch.**

## 🔍 Maintainers

| [Lucas Libshutz][ll] |
| :----------------------------------------------------------: |
| |

[ll]: https://github.com/lucaslibshutz