diff --git a/docs/projects/enhancing_bioinformatics_research_through_LLM/about.md b/docs/projects/baio/about.md similarity index 98% rename from docs/projects/enhancing_bioinformatics_research_through_LLM/about.md rename to docs/projects/baio/about.md index 6a38af475..9df6366e7 100644 --- a/docs/projects/enhancing_bioinformatics_research_through_LLM/about.md +++ b/docs/projects/baio/about.md @@ -1,6 +1,6 @@ --- id: about -title: Enhancing Bioinformatics Research through LLM +title: "BAIO: Baio (바이오) AI Output" custom_edit_url: null --- diff --git a/docs/projects/open_project/about.md b/docs/projects/coredesk/about.md similarity index 94% rename from docs/projects/open_project/about.md rename to docs/projects/coredesk/about.md index 5f1758f95..33501e00b 100644 --- a/docs/projects/open_project/about.md +++ b/docs/projects/coredesk/about.md @@ -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 diff --git a/docs/projects/dads/about.md b/docs/projects/dads/about.md index 7a85e58c5..d6d403d4b 100644 --- a/docs/projects/dads/about.md +++ b/docs/projects/dads/about.md @@ -1,6 +1,6 @@ --- id: about -title: DADS +title: "DADS: A Database of Arithmetical Dynamic Systems" custom_edit_url: null --- diff --git a/docs/projects/deer/about.md b/docs/projects/deer/about.md index a027f9105..01eb0b5da 100644 --- a/docs/projects/deer/about.md +++ b/docs/projects/deer/about.md @@ -1,6 +1,6 @@ --- id: about-deer -title: Data Entry & Exhibition for Rerum +title: "DEER: Data Entry & Exhibition for Rerum" custom_edit_url: null --- diff --git a/docs/projects/esp/about.md b/docs/projects/esp/about.md index 685a2db6c..1394056ca 100644 --- a/docs/projects/esp/about.md +++ b/docs/projects/esp/about.md @@ -1,6 +1,6 @@ --- id: about -title: Electronic Structure Parser +title: "ESP: Electronic Structure Parser" custom_edit_url: null --- diff --git a/docs/projects/iris/about.md b/docs/projects/iris/about.md index 91ed11a51..6c8061df5 100644 --- a/docs/projects/iris/about.md +++ b/docs/projects/iris/about.md @@ -1,6 +1,6 @@ --- id: about -title: Image Recognition Integration System (IRIS) +title: "IRIS: Image Recognition Integration System" custom_edit_url: null --- diff --git a/docs/projects/MDMA/about.md b/docs/projects/md/about.md similarity index 85% rename from docs/projects/MDMA/about.md rename to docs/projects/md/about.md index 9e36a54ec..0460fa96f 100644 --- a/docs/projects/MDMA/about.md +++ b/docs/projects/md/about.md @@ -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 diff --git a/docs/projects/meltshiny/about.md b/docs/projects/meltshiny/about.md index 01d69125d..3e29a9e65 100644 --- a/docs/projects/meltshiny/about.md +++ b/docs/projects/meltshiny/about.md @@ -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 [github](https://github.com/akurapati1) +- **Current Tech Lead:** Abhilash Kurapati [GitHub github](https://github.com/akurapati1) - **Developers:** - Andrew Vazzano (capstone) [github](https://github.com/avazzano7) - Samuel Mercier (capstone) [github](https://github.com/Canada101) diff --git a/docs/projects/saltify/about.md b/docs/projects/saltify/about.md index d57c98474..2c90a3c8f 100644 --- a/docs/projects/saltify/about.md +++ b/docs/projects/saltify/about.md @@ -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._ diff --git a/docs/projects/shelter_volunteers/about.md b/docs/projects/shelter_volunteers/about.md index 74f9b1537..8e96036d7 100644 --- a/docs/projects/shelter_volunteers/about.md +++ b/docs/projects/shelter_volunteers/about.md @@ -1,6 +1,6 @@ --- id: about -title: Homeless Shelter Volunteer Scheduling Application +title: Shelter Volunteer Rapid Response custom_edit_url: null --- @@ -8,7 +8,7 @@ custom_edit_url: null ## 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 diff --git a/docs/projects/tpeninterfaces/about.md b/docs/projects/tpen_interfaces/about.md similarity index 100% rename from docs/projects/tpeninterfaces/about.md rename to docs/projects/tpen_interfaces/about.md diff --git a/docs/projects/tpeninterfaces/tpen_architechture.png b/docs/projects/tpen_interfaces/tpen_architechture.png similarity index 100% rename from docs/projects/tpeninterfaces/tpen_architechture.png rename to docs/projects/tpen_interfaces/tpen_architechture.png diff --git a/docs/projects/tpeninterfaces/tpen_logo.png b/docs/projects/tpen_interfaces/tpen_logo.png similarity index 100% rename from docs/projects/tpeninterfaces/tpen_logo.png rename to docs/projects/tpen_interfaces/tpen_logo.png diff --git a/docs/resources/playbooks/style_guides/portfolio-template.md b/docs/resources/playbooks/style_guides/portfolio-template.md new file mode 100644 index 000000000..f36003a13 --- /dev/null +++ b/docs/resources/playbooks/style_guides/portfolio-template.md @@ -0,0 +1,95 @@ +--- +id: portfolio-template +title: "Portfolio Template" +--- + + +```md +--- +id: about +title: "Project/Product Name" +custom_edit_url: null +--- + + + + +## Overview + + + + + +### Basic Information + +- **Status:** + +- **Platforms:** +- **Website:** [URL](URL) +- **Source Code:** [URL](URL) [git](URL) +- **Download/Deployment:** + - [URL](URL) + - [URL](URL) + - [URL](URL) + +### User Guide + + + + + +**Quick Start:** +1. [Installation/Setup steps] +2. [Basic usage] +3. [Common workflows] + + +**Full User Guide:** [Link to detailed docs] + +## Core Dev Team: + +- **Client** +- **Staff Developer:** [github](https://github.com/username) [linkedin](https://www.linkedin.com/in/username/) +- **Current Tech Lead:** [github](https://github.com/username)[linkedin](https://www.linkedin.com/in/username/) [portfolio](Portfolio URL/) +- **Developers:** + + - (project staff) [github](https://github.com/rcAsironman) + - One Dev (capstone) [github](https://github.com/username) + - Two Dev (capstone) [github](https://github.com/husernameaneenalsewari) + - Green Dev (alumni) [github](https://github.com/Ebusernameruns4) + - Blue Dev (alumni, prior tech lead) [github](https://github.com/SiriChanusernamedanaGarimella) [linkedin](https://www.linkedin.com/in/username/) + +## Technical Information + +### Additional Information + +- **Start Date:** +- **Adoption 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) + + +### 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 + + + + +``` \ No newline at end of file diff --git a/docs/resources/playbooks/style_guides/projects-products.md b/docs/resources/playbooks/style_guides/projects-products.md new file mode 100644 index 000000000..033f0337e --- /dev/null +++ b/docs/resources/playbooks/style_guides/projects-products.md @@ -0,0 +1,521 @@ +# Project/Product Branding and Style Guide + +Building *branding and style* consistency across *projects and products* + +--- + +## Project Title Formatting + +### Primary Guidelines + +All project titles should follow these core principles for maximum consistency and professional presentation. + +#### Short Memorable Names + +**Format**: Proper noun capitalization with original styling preserved + +**Examples**: + +- DroneWorld +- Where's Religion +- Pi4Micronaut + +**Rules**: + +- Capitalize as proper nouns +- Preserve original capitalization decisions (DroneWorld vs Drone World) +- Maintain numbers and special characters as intended +- Keep apostrophes and punctuation in original form + +#### Acronym-Based Projects + +**Primary Format**: `ACRONYM: Full Expanded Name` + +**Examples**: + +- **IRIS**: Image Recognition Integration System +- **BAIO**: Baio (바이오) AI Output +- **DADS**: A Database of Arithmetical Dynamic Systems + +**Rules**: + +- Acronym always in ALL CAPS +- Colon and single space separator (`:`) +- Expanded name in Title Case (capitalize major words) +- Preserve initial articles ("A Database...", "The System...") +- Include parenthetical additions and foreign language elements +- Maintain special characters and formatting + +#### Alternative Acronym Formats + +For specific contexts, these variations are acceptable: + +**Short Reference**: Use acronym only + +- IRIS, BAIO, DADS + +**Marketing/Casual**: Lead with memorable element + +- Baio AI (BAIO), DroneWorld Simulation Platform + +**Technical Documentation**: Full specification + +- Image Recognition Integration System (IRIS) v2.1 + +### Mixed Project Lists + +When presenting multiple projects together, group by type for visual consistency: + +**Acronym Projects** (alphabetical): + +- **BAIO**: Baio (바이오) AI Output +- **DADS**: A Database of Arithmetical Dynamic Systems +- **IRIS**: Image Recognition Integration System + +**Named Projects** (alphabetical): + +- DroneWorld +- Pi4Micronaut +- Where's Religion + +### Product Versions and Variants + +When a project has multiple formats, platforms, or specialized versions, maintain consistency while clearly distinguishing between variants. + +#### Format Guidelines + +**Primary Format**: `ProductName PlatformType` + +**Examples**: + +- Shelter Volunteers Rapid Response Web +- IRIS Mobile +- BAIO Desktop +- DroneWorld API + +#### Platform/Format Types + +**Standard Platform Designations**: + +- **Mobile** - iOS, Android, mobile web applications +- **Desktop** - Windows, macOS, Linux desktop applications +- **Web** - Browser-based applications +- **API** - Application programming interfaces +- **CLI** - Command-line interfaces +- **Library** - Code libraries and SDKs + +#### Documentation Standards + +**Title Page Format**: + +``` +# ProductName PlatformType +*Brief descriptor of platform-specific features* + +**Base Project**: [Link to main product] +**Platform**: [Specific platform details] +**Version**: [Current version number] +``` + +**Cross-Reference Requirements**: + +- Always reference the base product in variant documentation +- Maintain links between related platform versions +- Use consistent naming across all variants + +#### Multiple Platform Collections + +**Project Suite Format**: +When documenting multiple platforms together: + +``` +# ProjectName Suite +*Comprehensive solution across platforms* + +## Available Platforms +- **ProjectName Mobile** - iOS and Android applications +- **ProjectName Web** - Browser-based interface +- **ProjectName API** - Developer integration tools +- **ProjectName CLI** - Command-line administration +``` + +#### Abbreviation Guidelines + +**Acceptable Abbreviations**: + +- API (always capitalized) +- CLI (always capitalized) +- Mobile, Web, Desktop (full words preferred) + +**Repository/Technical Naming**: + +- Use lowercase with underscores: `shelter_volunteers_mobile` +- Include platform designation: `iris_api`, `baio_desktop` +- Maintain consistency with main project naming +- **Exception**: Use hyphens when they already exist in the original name + +### Core Processes + +**Format**: `ACRONYM - Full Name` or creative branding + +**Examples**: + +- **BLA3DE** - Balanced Leadership, Allocation and Assignment, Democratic Engagement +- **KNIFE FIGHT** - Keen Negotiation In Friendly Environment - Forging Intentional Group Harmony Together + +**Guidelines**: + +- Use creative typography when it enhances memorability (3 for E in BLA3DE) +- Maintain professional tone while embracing playful elements +- Ensure acronyms are pronounceable and memorable +- Include full expansion for clarity + +### Sub-processes + +**Format**: Component naming should relate to parent process + +**Examples**: + +- KNIFE (environment setup) +- FIGHT (execution process) + +--- + +## Typography Standards + +### Headers and Titles + +**H1**: Project/document titles + +- Always include organization context where appropriate +- Use proper case formatting per project guidelines + +**H2**: Major sections + +- Sentence case preferred +- Avoid unnecessary capitalization + +**H3-H4**: Subsections + +- Consistent with H2 approach +- Use parallel structure within documents + +### Emphasis + +**Bold**: Use for true emphasis, process names, and key terms + +- Avoid bold for pseudo-headers +- Use sparingly for maximum impact + +**Italics**: Explanatory text, quotes, and subtitles + +- Foreign language terms +- Book/document titles + +**Code formatting**: Technical terms, file names, exact commands + +- `Pi4Micronaut`, `README.md`, `git commit` + +### Special Characters + +**Acceptable special characters**: + +- Colons for acronym separation (`:`) +- Parentheses for clarification `(explanation)` +- Numbers as letters (like 4 in `Pi4Micronaut`) +- Apostrophes in proper names `Where's Religion` + +--- + +## Brand Voice & Tone + +### Core Principles + +**Professional yet Approachable**: Maintain academic credibility while being accessible + +**Collaborative**: Language emphasizes partnership and community building + +**Innovation-Focused**: Embrace creativity and cutting-edge approaches + +**Open Source Values**: Transparency, collaboration, democratic participation + +### Language Guidelines + +**Active Voice Preferred**: "We build" not "Software is built" + +**Inclusive Language**: Use "we," "our," and "community" + +**Clear and Direct**: Avoid unnecessary jargon or complex terminology + +**Energetic but Respectful**: Enthusiasm without unprofessionalism + +### Process Language + +**Problem-Solving**: Frame challenges as opportunities for collaboration + +**Conflict Resolution**: Embrace productive tension rather than conflict avoidance + +**Decision Making**: Emphasize democratic participation and voluntary engagement + +--- + +## Visual Consistency + +### Document Structure + +**Standard Header**: Organization name, project/process title, clear purpose statement + +**Consistent Sections**: Use parallel structure across similar documents + +**Clear Hierarchy**: Logical header progression (H1 → H2 → H3 → H4) + +**White Space**: Generous spacing for readability + +### Lists and Formatting + +**Bullet Points**: Use for related items, avoid in prose sections + +**Numbered Lists**: For sequential processes or ranked items + +**Code Blocks**: Technical examples and exact formatting + +**Emphasis**: Consistent bold/italic usage per typography standards + +--- + +## Application Examples + +### Project Documentation + +**Title Page Format**: + +``` +# IRIS: Image Recognition Integration System +*Computer Vision Platform for Research Applications* + +**Purpose**: [Clear description] +**Status**: [Development phase] +**Team**: [Key contributors] +``` + +**Another Example**: + +``` +# BAIO: Baio (바이오) AI Output +*AI Content Generation Platform* + +**Purpose**: [Clear description] +**Status**: [Development phase] +**Team**: [Key contributors] +``` + +**Email Subject Lines**: + +- Project updates: `[PROJECT]: Brief descriptive title` + +--- + +## Project Portfolio Documentation + +### Portfolio Profile Pages + +All projects should have a standardized portfolio profile page following the established template structure. These pages serve as the primary public-facing documentation and should maintain consistency across all projects. + +#### Required Template Structure + +**Standard Section Order**: + +1. **Overview** - Project description, screenshots, demo videos +2. **Basic Information** - Status, platforms, key links +3. **User Guide** - Getting started and documentation links +4. **Core Dev Team** - Client, staff, and contributor information +5. **Technical Information** - Architecture and metadata +6. **Development Priorities** - Current and future development focus +7. **Get Involved** - Contribution guidelines and contact + +#### Content Guidelines + +**Overview Section**: + +- Include project screenshots when available +- Provide 1-2 paragraph description suitable for general audience +- Link to demo videos (YouTube, Vimeo, or direct links) +- Use clear, non-technical language + +**Basic Information Requirements**: + +- **Status**: Choose from standardized options (Proposed, New, Active, External, Support, Handoff, Archived) +- **Platforms**: Select applicable types (Mobile, Desktop, Web, API, CLI, Library) +- **Links**: Website, source code, download/deployment links as available + +**User Guide Standards**: + +- Target end users, not developers +- Include Quick Start section with 3 key steps +- Link to comprehensive external documentation +- Describe intended audience and use cases + +**Team Documentation**: + +- **Client**: Organization or individual requesting the project +- **Staff Developer**: Full-time OSS@SLU staff member +- **Current Tech Lead**: Student or staff member leading development +- **Developers**: List all contributors with roles and timeframes + +**Team Member Information Format**: + +```markdown +- Name (role, timeframe) [GitHub icon](GitHub URL) [LinkedIn icon](LinkedIn URL) [Portfolio icon](Portfolio URL) +``` + +**Technical Information Structure**: + +- **Additional Information**: Metadata (dates, technologies, licenses) +- **Technical Overview**: Architecture diagrams and technical description +- **Development Priorities**: Current semester focus, next semester plans, external contributor opportunities + +#### Formatting Standards + +**Social Media Icons**: + +- Use consistent spacing: one space between each icon link +- Standard icon set: GitHub, LinkedIn, Portfolio +- Alt text format: `alt="github"`, `alt="linkedin"`, `alt="portfolio"` +- Consistent sizing: `width="25" height="25"` + +**Image Guidelines**: + +- **Header images**: Optional, maximum 200x600 pixels +- **Screenshots**: Include in Overview section when available +- **Architecture diagrams**: Use in Technical Overview section +- **Alt text**: Provide descriptive alt text for all images + +**Link Formatting**: + +- **External links**: `[Display Text](URL)` +- **Repository links**: Include both text and icon: `[URL](URL) [GitHub git](URL)` +- **Documentation links**: Use descriptive link text + +#### Status Definitions + +**Project Status Options**: + +- **Proposed**: Requested by client, not yet started +- **New**: Greenfield development this semester +- **Active**: Ongoing development and maintenance +- **External**: Third-party project we contribute to +- **Support**: Limited maintenance, feature-complete +- **Handoff**: Transitioning back to client control +- **Archived**: No further updates planned + +#### Team Role Definitions + +**Core Roles**: + +- **Client**: Organization or individual who requested the project +- **Staff Developer**: Full-time OSS@SLU employee providing oversight +- **Current Tech Lead**: Person responsible for technical direction and student mentoring +- **Developers**: Contributors including staff, students, and alumni + +**Role Indicators**: + +- `(project staff)` - Current OSS@SLU staff member +- `(capstone)` - Current capstone student +- `(alumni)` - Former student contributor +- `(prior tech lead)` - Former technical leader +- Include timeframes when relevant: `(Fall 2024 capstone)` + +#### Technical Metadata Requirements + +**Required Information**: + +- **Start Date**: When development began +- **Adoption Date**: When project went into active use (if applicable) +- **Technologies Used**: Primary technology stack +- **License**: Link to specific open source license +- **Code of Conduct**: Link to project's CODE_OF_CONDUCT.md +- **Security**: Link to project's SECURITY.md + +**Technology Stack Format**: + +```markdown +- **Technologies Used:** + - Primary Language/Framework + - Database Technology + - Frontend Framework + - Deployment Platform + - Key Libraries +``` + +#### Implementation Guidelines + +**Template Usage**: + +- Copy template for each new project +- Update all placeholder content +- Follow naming conventions from project style guide +- Ensure all links are functional before publication + +**Content Reviews**: + +- Technical accuracy review by project tech lead +- User experience review by staff developer +- Style consistency review against this guide +- Annual updates to reflect current project status + +**Repository Integration**: + +- Portfolio pages should link to project repositories +- Repository README files should link back to portfolio pages +- Maintain consistency between repository and portfolio descriptions + +#### Quality Checklist + +Before publishing a portfolio page, verify: + +- [ ] All placeholder text has been replaced +- [ ] Project name follows established style guide formatting +- [ ] All links are functional and point to correct resources +- [ ] Team member information is current and accurate +- [ ] Social media icons have consistent spacing and sizing +- [ ] Images include appropriate alt text +- [ ] Status accurately reflects current project state +- [ ] Technical information is current and accurate +- [ ] Development priorities reflect current semester plans + +### Template Reference + +The complete portfolio template is maintained as a separate document and should be used as the foundation for all project portfolio pages. Regular updates to the template will be communicated through standard channels, and existing portfolio pages should be updated to maintain consistency. + +**Template Location**: [Portfolio Template](portfolio-template.md) + +**Last Updated**: [Date when template was last revised] + +**Template Version**: [Version number for tracking changes] + +---- + +## Implementation Guidelines + +### Consistency Checklist + +Before publishing any materials, verify: + +- [ ] Project titles follow established format +- [ ] Acronyms are properly capitalized and expanded +- [ ] Typography follows established hierarchy +- [ ] Voice and tone align with brand principles +- [ ] Document structure is consistent with similar materials + +### Evolution and Updates + +This guide is a living document that should: + +- Evolve based on practical experience +- Incorporate feedback from team members +- Maintain core consistency while allowing innovation +- Be updated when new project types or processes are developed + +**Review Schedule**: Quarterly review and updates as needed + +**Feedback Process**: Open issues or direct communication for suggested improvements diff --git a/sidebars.js b/sidebars.js index 8447e2b4d..fffabe29a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -269,7 +269,7 @@ const sidebars = { }, { type: 'doc', - id: 'projects/enhancing_bioinformatics_research_through_LLM/about', + id: 'projects/baio/about', }, { type: 'doc', @@ -281,7 +281,7 @@ const sidebars = { }, { type: 'doc', - id: 'projects/MDMA/about', + id: 'projects/md/about', }, { type: 'doc', @@ -297,7 +297,7 @@ const sidebars = { }, { type: 'doc', - id: 'projects/open_project/about', + id: 'projects/coredesk/about', }, { type: 'doc', @@ -326,7 +326,7 @@ const sidebars = { }, { type: 'doc', - id: 'projects/tpeninterfaces/about', + id: 'projects/tpen_interfaces/about', }, { type: 'doc', diff --git a/src/data/projects/Projects.json b/src/data/projects/Projects.json index 5de2d5abd..fc60288bc 100644 --- a/src/data/projects/Projects.json +++ b/src/data/projects/Projects.json @@ -1,6 +1,6 @@ [ { - "name": "DADS (Database of Arithmetic Dynamical Systems)", + "name": "DADS: Database of Arithmetic Dynamical Systems", "url": "/projects/dads/about", "description": "DADS is a flexible, web-based, search-driven user interface for a database of information about a class of mathematical functions known as arithmetic dynamical systems.", "status": "current", @@ -28,14 +28,14 @@ "image": "/img/projects/esp.png" }, { - "name": "Enhancing Bioinformatics Research through LLM", - "url": "/projects/enhancing_bioinformatics_research_through_LLM/about", + "name": "BAIO: Baio (바이오) AI Output", + "url": "/projects/baio/about", "description": "This project is focused on developing an AI-driven tool that supports bioinformatics research by providing intelligent API recommendations, detecting errors, and offering real-time corrections. The tool leverages large language models trained on bioinformatics codebases to ensure reliable data retrieval and analysis, ultimately improving research accuracy and efficiency.", "status": "current", - "image": "/img/projects/enhancing_bioinformatics_research_through_LLM.png" + "image": "/img/projects/baio.png" }, { - "name": "Image Recognition Integration System", + "name": "IRIS: Image Recognition Integration System", "url": "/projects/iris/about", "description": "IRIS is a framework for creating custom mobile applications that can handle specialized image search problems. The framework was developed to create an application that uses a custom AI model to identify details about orthopedic screws from x-ray images of a patient.", "status": "current", @@ -56,9 +56,9 @@ "image": "/img/projects/mouser.png" }, { - "name": "Open Project", - "url": "/projects/open_project/about", - "description": "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.", + "name": "CoreDesk", + "url": "/projects/coredesk/about", + "description": "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.", "status": "current", "image": "/img/projects/open_project.png" }, @@ -77,7 +77,7 @@ "image": "/img/projects/python_tbe.png" }, { - "name": "Speech Tagging", + "name": "Saltify Speech Transcription", "url": "/projects/saltify/about", "description": "Saltify Speech Tagging software transcribes an audio sample into a written format that is accepted by SALT software.", "status": "current", @@ -112,11 +112,11 @@ "image": "/img/projects/innerpeacetime.png" }, { - "name": "Material Donor Mutual Assist", - "url": "/projects/MDMA/about", - "description": "The Material Donor Mutual Assist project by BWorks simplifies donation management by allowing donors to track their contributions from donation to use, fostering trust and encouraging ongoing support.", + "name": "MaterialDerailleur", + "url": "/projects/md/about", + "description": "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.", "status": "current", - "image": "/img/projects/MDMA.png" + "image": "/img/projects/md.png" }, { "name": "Open Energy Dashboard", @@ -133,15 +133,15 @@ "image": "/img/projects/pi4micronaut.png" }, { - "name": "Shelter Volunteers", + "name": "Shelter Volunteers Rapid Response", "url": "/projects/shelter_volunteers/about", - "description": "Simplify the process of scheduling work shifts for volunteers, and to give homeless shelters visibility into their upcoming staffing.", + "description": "Simplify the process of scheduling work shifts for volunteers at temporary shelters, and to give homeless shelters visibility into their upcoming staffing.", "status": "current", "image": "/img/projects/shelter_volunteers.png" }, { "name": "TPEN Interfaces", - "url": "/projects/tpeninterfaces/about", + "url": "/projects/tpen_interfaces/about", "description": "The TPEN Interfaces project provides a set of customizable web interfaces that leverage the TPEN Services API.", "status": "current", "image": "/img/projects/tpeninterfaces.png"