Skip to content

start some project rebranding and new implement a new style guide #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: about
title: Enhancing Bioinformatics Research through LLM
title: "BAIO: Baio (바이오) AI Output"
custom_edit_url: null
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
id: about
title: SLU Open Project
title: CoreDesk
custom_edit_url: null
---

## Overview

SLU Open Project is a web-based work management tool that enables shared service providers in universities and similar contexts. It was originally built to support the SLU Center for Additive Manufacturing (SLU-CAM), and is expanding to support a variety of use cases.
CoreDesk is a web-based work management tool that enables shared service providers in universities and similar contexts. It was originally built to support the SLU Center for Additive Manufacturing (SLU-CAM), and is expanding to support a variety of use cases.

## Information

Expand Down
2 changes: 1 addition & 1 deletion docs/projects/dads/about.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: about
title: DADS
title: "DADS: A Database of Arithmetical Dynamic Systems"
custom_edit_url: null
---

Expand Down
2 changes: 1 addition & 1 deletion docs/projects/deer/about.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: about-deer
title: Data Entry & Exhibition for Rerum
title: "DEER: Data Entry & Exhibition for Rerum"
custom_edit_url: null
---
<!-- A header image is optional; if used should be no greater than 200x600 -->
Expand Down
2 changes: 1 addition & 1 deletion docs/projects/esp/about.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: about
title: Electronic Structure Parser
title: "ESP: Electronic Structure Parser"
custom_edit_url: null
---

Expand Down
2 changes: 1 addition & 1 deletion docs/projects/iris/about.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: about
title: Image Recognition Integration System (IRIS)
title: "IRIS: Image Recognition Integration System"
custom_edit_url: null
---

Expand Down
4 changes: 2 additions & 2 deletions docs/projects/MDMA/about.md → docs/projects/md/about.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
id: about
title: Material Donor Mutual Assist
title: MaterialDerailleur
custom_edit_url: null
---

## Overview

The Material Donor Mutual Assist project by BWorks is designed to streamline the process of managing donations, providing a transparent view into the journey of each donated item. This initiative allows donors to track their contributions from the moment they are donated to their ultimate use, offering them a detailed view of how their items are making a difference. By keeping donors informed about the status and use of their donations, the project fosters a sense of trust and community, encouraging continued support and involvement. The system simplifies the administrative tasks involved in updating and managing donations, making it easier to attract and retain donors who are motivated by seeing the tangible impact of their contributions.
MaterialDerailleur shifts donations into drive for BWorks. It streamlines the process of managing material donations, providing a transparent view into the journey of each donated item. This initiative allows donors to track their contributions from the moment they are donated to their ultimate use, offering them a detailed view of how their items are making a difference. By keeping donors informed about the status and use of their donations, the project fosters a sense of trust and community, encouraging continued support and involvement. The system simplifies the administrative tasks involved in updating and managing donations, making it easier to attract and retain donors who are motivated by seeing the tangible impact of their contributions.

### Information

Expand Down
2 changes: 1 addition & 1 deletion docs/projects/meltshiny/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ MeltShiny is a software application that automates the analysis and visualizatio
- **Clients:**
- [Dr. Brent Znosko](https://www.slu.edu/science-and-engineering/academics/chemistry/faculty/brent-znosko.php)
- Sebastian Arteaga (Assistant)
- **Current Tech Lead:** Abhilash Kurapati [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/akurapati1)
- **Current Tech Lead:** Abhilash Kurapati [GitHub <img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/akurapati1)
- **Developers:**
- Andrew Vazzano (capstone) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/avazzano7)
- Samuel Mercier (capstone) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/Canada101)
Expand Down
4 changes: 2 additions & 2 deletions docs/projects/saltify/about.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
id: about
title: Speech Transcription (Saltify)
title: Saltify Speech Transcription
custom_edit_url: null
---

## Overview

![Alt](100x100.png) Children naturally produce speech sound errors, language errors, and language features, such as disfluencies. Language errors and features are diagnostically meaningful to speech-language pathologists (SLPs) and need to be maintained in the transcription. The primary purpose of the application is to transcribe an audio sample into a written format that is accepted by SALT software. SALT software is commercially-licensed software that analyzes the speech of children and scores it according to their metrics. Our application can currently transcribe audio samples of a conversation between a child and an adult into text. It also allows users to add grammar checking to the transcription, which looks for possible errors in grammar within the text.
![Alt](100x100.png) Saltify transcribes and annotates interviews into formats useful for speech language pathologists. Children naturally produce speech sound errors, language errors, and language features, such as disfluencies. Language errors and features are diagnostically meaningful to speech-language pathologists (SLPs) and need to be maintained in the transcription. The first target format was for SALT software. SALT software is commercially-licensed software that analyzes the speech of children and scores it according to their metrics. Our application can currently transcribe audio samples of a conversation between a child and an adult into text. It also allows users to add grammar checking to the transcription, which looks for possible errors in grammar within the text.

_Note: careful review by a knowledgeable speech-language pathologist is required for an accurate final product._

Expand Down
4 changes: 2 additions & 2 deletions docs/projects/shelter_volunteers/about.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
id: about
title: Homeless Shelter Volunteer Scheduling Application
title: Shelter Volunteer Rapid Response
custom_edit_url: null
---
<!-- A header image is optional; if used should be no greater than 200x600 -->
<!--![Header Alt Text](header.png) -->

## Overview

Homeless shelters rely on volunteers' help. When inclement weather strikes, homeless shelters get filled with people that need a place to stay, and volunteers' help becomes even more important. There are many people willing to volunteer, but knowing which shelter lacks help is a challenge. The purpose of this application is to simplify the process of scheduling work shifts for volunteers, and to give homeless shelters visibility into their upcoming staffing. The application allows volunteers to select shelters and times when they want to work, see which shelters (and which times) urgently need help, and cancel/reschedule their shifts. The application will also allow shelter staff to see who is scheduled to help at their shelter on different dates and different times, and issue a 'call for help' when help is needed urgently.
Homeless shelters rely on volunteers' help. When inclement weather strikes, homeless shelters get filled with people that need a place to stay, and volunteers' help becomes even more important. There are many people willing to volunteer, but knowing which shelter lacks help is a challenge. Shelter Volunteer Rapid Response simplifies the process of scheduling work shifts for volunteers, and to give homeless shelters visibility into their upcoming staffing. The application allows volunteers to select shelters and times when they want to work, see which shelters (and which times) urgently need help, and cancel/reschedule their shifts. The application will also allow shelter staff to see who is scheduled to help at their shelter on different dates and different times, and issue a 'call for help' when help is needed urgently.

### Information

Expand Down
95 changes: 95 additions & 0 deletions docs/resources/playbooks/style_guides/portfolio-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
id: portfolio-template
title: "Portfolio Template"
---


```md
---
id: about
title: "Project/Product Name"
custom_edit_url: null
---

<!-- A header image is optional; if used should be no greater than 200x600 -->
<!--![Header Caption](header.png) -->

## Overview

<!-- Screenshot -->
<!-- Clear description; 1-2 paragraphs -->
<!-- Demo/prview video -->

### Basic Information

- **Status:** <!-- Choose applicable: [Proposed (proposed by client), New (greenfield this semester), Active (and ongoing), External (ongoing third-party), -->
<!-- Support (limited maintenance), Handoff (back to client), Archived (no further updates will be made)] -->
- **Platforms:** <!-- Choose applicable: [Mobile, Desktop, Web, API, CLI, Library] -->
- **Website:** [URL](URL)
- **Source Code:** [URL](URL) [<img src="/img/git-alt.svg" alt="git" width="25" height="25" />](URL)
- **Download/Deployment:**
- [URL](URL)
- [URL](URL)
- [URL](URL)

### User Guide

<!-- Clear description; 1-2 paragraphs -->
<!-- Clear description of who should use this and how -->
<!-- Getting started steps or quick-start guide -->

**Quick Start:**
1. [Installation/Setup steps]
2. [Basic usage]
3. [Common workflows]

<!-- Link to comprehensive documentation -->
**Full User Guide:** [Link to detailed docs]

## Core Dev Team:

- **Client** <!-- Client Name -->
- **Staff Developer:** <!-- Staff Developer Name --> [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/username) [<img src="/img/linkedin.svg" alt="linkedin" width="25" height="25" />](https://www.linkedin.com/in/username/)
- **Current Tech Lead:** <!-- Tech Lead Name --> [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/username)[<img src="/img/linkedin.svg" alt="linkedin" width="25" height="25" />](https://www.linkedin.com/in/username/) [<img src="/img/portfolio.svg" alt="portfolio" width="25" height="25" />](Portfolio URL/)
- **Developers:**

- <!-- Name --> (project staff) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/rcAsironman)
- One Dev (capstone) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/username)
- Two Dev (capstone) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/husernameaneenalsewari)
- Green Dev (alumni) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/Ebusernameruns4)
- Blue Dev (alumni, prior tech lead) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/SiriChanusernamedanaGarimella) [<img src="/img/linkedin.svg" alt="linkedin" width="25" height="25" />](https://www.linkedin.com/in/username/)

## Technical Information

### Additional Information

- **Start Date:** <!-- Date -->
- **Adoption Date:** <!-- Date -->
- **Technologies Used:**
- Tech
- Stack
- Primary
- Tech
- Only
- **License:** [license short name](https://opensource.org/license/...)
- **Code of Conduct:** [CODE_OF_CONDUCT.md](URL)
- **Security:** [SECURITY.md](URL)

### Technical Overview

![Software Architecture](architecture.png)
<!-- Clear description; 1-2 paragraphs -->

### Development Priorities

- List of current priorities
- Should be able to succinctly identify what is expected over the current semester
- Hint at what is coming for the next semester
- Provide at least one extra priority for external contributors

## Get Involved

<!-- Clear description; 1-2 paragraphs -->
<!-- Link to CONTRIBUTING.md -->

```
Loading