Skip to content

Commit cbcded0

Browse files
Meatball1601Meatball1601
committed
More documentation
1 parent b16cf6b commit cbcded0

14 files changed

Lines changed: 287 additions & 0 deletions

‎docs/application-management.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Application Management
2+
3+
This guide explains how to manage the application form and status on the website.
4+
5+
## Where to Edit
6+
- `src/config/applicationConfig.ts` for application settings
7+
8+
## Fields
9+
- isOpen, formUrl, closedMessage, openMessage
10+
11+
## TODO
12+
- Add example config for open/closed states
13+
- Document how to update the Google Form link
14+
- Add tips for communicating application status
15+
16+
---
17+
18+
*Contributions welcome! Add your workflow or tips for managing the application process.*

‎docs/components.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Component Guide
2+
3+
This guide explains the structure and usage of React components in the Open Hardware Initiative website.
4+
5+
## Component Structure
6+
- Where components live (`src/components/`)
7+
- Naming conventions
8+
- UI vs. page components
9+
10+
## Best Practices
11+
- Reusability
12+
- Props and typing
13+
- Styling with Tailwind
14+
15+
## TODO
16+
- Add examples of component usage
17+
- Document key components and their props
18+
- Add a diagram of component hierarchy
19+
20+
---
21+
22+
*Contributions welcome! Add examples and explanations for new contributors.*

‎docs/configuration.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Configuration Guide
2+
3+
This guide explains the main configuration files and settings for the website.
4+
5+
## Key Files
6+
- `vite.config.ts` (build and dev server)
7+
- `tailwind.config.ts` (styling)
8+
- `tsconfig.json` (TypeScript)
9+
- `src/config/applicationConfig.ts` (application form)
10+
11+
## TODO
12+
- Add example config changes
13+
- Document how to add new config options
14+
- Add tips for keeping configs organized
15+
16+
---
17+
18+
*Contributions welcome! Add your notes on configuration best practices.*

‎docs/debugging.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Debug Guide
2+
3+
This guide explains how to debug issues in the website.
4+
5+
## Debugging Tools
6+
- Browser dev tools (console, network, elements)
7+
- Vite error overlays
8+
- ESLint for code issues
9+
10+
## Common Debugging Steps
11+
- Reproduce the issue locally
12+
- Check error messages in terminal and browser
13+
- Use breakpoints and logging
14+
15+
## TODO
16+
- Add example debugging scenarios
17+
- Document how to debug deployment issues
18+
- Add tips for remote debugging
19+
20+
---
21+
22+
*Contributions welcome! Add your debugging workflows and tips.*

‎docs/development.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Development Guide
2+
3+
This guide explains how to set up and work on the Open Hardware Initiative website as a developer.
4+
5+
## Local Setup
6+
- Prerequisites (Bun, Node.js, Git)
7+
- Cloning the repo
8+
- Installing dependencies
9+
- Running the dev server
10+
11+
## Workflow
12+
- Branching strategy
13+
- Commit message guidelines
14+
- Code review process
15+
16+
## TODO
17+
- Add screenshots of local dev environment
18+
- Document advanced dev workflows (linting, testing, etc.)
19+
- Add tips for debugging and troubleshooting
20+
21+
---
22+
23+
*Contributions welcome! Add your tips and best practices for development.*

‎docs/domain-configuration.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Domain Configuration
2+
3+
This guide explains how to set up and manage the custom domain for the website.
4+
5+
## Custom Domain
6+
- `open-hardware-initiative.com`
7+
- Managed via CNAME file and GitHub Pages settings
8+
9+
## DNS Setup
10+
- CNAME record pointing to GitHub Pages
11+
- Enforce HTTPS
12+
13+
## TODO
14+
- Add step-by-step DNS setup guide
15+
- Document how to update the CNAME file
16+
- Add troubleshooting for domain issues
17+
18+
---
19+
20+
*Contributions welcome! Add your experience with domain setup or DNS providers.*

‎docs/event-management.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Event Management
2+
3+
This guide explains how to add, edit, or remove events on the website.
4+
5+
## Where to Edit
6+
- `src/data/eventsData.ts` for event data
7+
- `public/media/events/` for images
8+
9+
## Fields
10+
- Title, date, time, location, description, image, registration, status, category
11+
12+
## TODO
13+
- Add example event entry
14+
- Document how to mark events as past/upcoming
15+
- Add tips for event promotion
16+
17+
---
18+
19+
*Contributions welcome! Add your workflow or tips for managing the events section.*

‎docs/github-actions.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# GitHub Actions
2+
3+
This document explains the automated deployment workflow for the website.
4+
5+
## What It Does
6+
- Builds the site on every push to main
7+
- Deploys the built files to GitHub Pages
8+
- Handles custom domain configuration
9+
10+
## Workflow File
11+
- `.github/workflows/deploy.yml`
12+
13+
## TODO
14+
- Add a diagram of the workflow steps
15+
- Document how to debug failed runs
16+
- Add tips for customizing the workflow
17+
18+
---
19+
20+
*Contributions welcome! Add more details or troubleshooting tips for CI/CD.*

‎docs/project-management.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Project Management
2+
3+
This guide explains how to add, edit, or remove projects on the website.
4+
5+
## Where to Edit
6+
- `src/data/projectsData.ts` for project data
7+
- `public/media/projects/` for images
8+
9+
## Fields
10+
- Title, description, image, technologies, links, status, team, year
11+
12+
## TODO
13+
- Add example project entry
14+
- Document how to feature a project
15+
- Add tips for writing good project descriptions
16+
17+
---
18+
19+
*Contributions welcome! Add your workflow or tips for managing the projects section.*

‎docs/project-overview.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Project Overview
2+
3+
This document provides a high-level overview of the Open Hardware Initiative website project.
4+
5+
## Purpose
6+
- Describe the goals and vision of the website
7+
- Outline the main features and sections
8+
- Explain the intended audience and use cases
9+
10+
## Main Sections
11+
- Home/Landing page
12+
- Team, Projects, Events, Application, Contact
13+
- Admin and content management approach
14+
15+
## TODO
16+
- Add a diagram of the site structure
17+
- Expand on each section with screenshots and descriptions
18+
- List key contributors and roles
19+
20+
---
21+
22+
*Contributions welcome! Expand this doc to help new team members understand the big picture.*

0 commit comments

Comments
 (0)