Skip to content

Commit b16cf6b

Browse files
Meatball1601Meatball1601
committed
Updated documenation
1 parent 0a91671 commit b16cf6b

7 files changed

Lines changed: 1062 additions & 50 deletions

File tree

‎README.md‎

Lines changed: 47 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This repository contains the official website for the Open Hardware Initiative, built with React, TypeScript, and Vite.
44

5+
## 🚀 Quick Start
6+
7+
Want to get started quickly? See our **[Quick Start Guide](docs/quick-start.md)** for a 5-minute setup.
8+
59
## 🚀 Deployment
610

711
This website is automatically deployed using **GitHub Actions**. When you push changes to the `main` branch, the following happens automatically:
@@ -26,13 +30,37 @@ This website is automatically deployed using **GitHub Actions**. When you push c
2630
│ ├── public/ # Static assets
2731
│ ├── data/ # Content data files
2832
│ └── ... # Configuration files
29-
├── media/ # Media assets (images, etc.)
33+
├── docs/ # 📚 Comprehensive documentation
3034
└── README.md # This file
3135
```
3236

37+
## 📚 Documentation
38+
39+
We have comprehensive documentation to help you work with the website:
40+
41+
### 🚀 Getting Started
42+
- **[Quick Start Guide](docs/quick-start.md)** - Get up and running in 5 minutes
43+
- **[Project Overview](docs/project-overview.md)** - Understanding the website structure
44+
45+
### 📝 Content Management
46+
- **[Content Management Guide](docs/content-management.md)** - How to update website content
47+
- **[Team Management](docs/team-management.md)** - Adding/editing team members
48+
- **[Project Management](docs/project-management.md)** - Adding/editing projects
49+
- **[Event Management](docs/event-management.md)** - Adding/editing events
50+
- **[Application Management](docs/application-management.md)** - Managing application forms
51+
52+
### 🚀 Deployment & Hosting
53+
- **[Deployment Guide](docs/deployment.md)** - How the website is deployed
54+
- **[GitHub Actions](docs/github-actions.md)** - Understanding the automated workflow
55+
- **[Domain Configuration](docs/domain-configuration.md)** - Custom domain setup
56+
57+
### 🐛 Troubleshooting
58+
- **[Troubleshooting Guide](docs/troubleshooting.md)** - Solutions to common problems
59+
- **[Debug Guide](docs/debugging.md)** - How to debug issues
60+
3361
## 🛠️ Development
3462

35-
For local development, see the [Source code/README.md](Source%20code/README.md) file for detailed instructions.
63+
For local development, see the **[Development Guide](docs/development.md)** for detailed instructions.
3664

3765
## 📝 Content Management
3866

@@ -49,4 +77,20 @@ For local development, see the [Source code/README.md](Source%20code/README.md)
4977

5078
## 📞 Support
5179

52-
For questions or issues, please contact the development team or create an issue in this repository.
80+
For questions or issues:
81+
1. Check the **[Troubleshooting Guide](docs/troubleshooting.md)**
82+
2. Review the **[Documentation Index](docs/README.md)**
83+
3. Create an issue in this repository
84+
4. Contact the development team
85+
86+
## 🎯 Quick Links
87+
88+
- **Live Website**: [open-hardware-initiative.com](https://open-hardware-initiative.com)
89+
- **GitHub Repository**: [OpenHardware-Initiative/OpenHardware-Initiative.github.io](https://github.com/OpenHardware-Initiative/OpenHardware-Initiative.github.io)
90+
- **GitHub Actions**: [Workflow runs](https://github.com/OpenHardware-Initiative/OpenHardware-Initiative.github.io/actions)
91+
- **Documentation**: [docs/README.md](docs/README.md)
92+
93+
---
94+
95+
**Last Updated**: December 2024
96+
**Maintained by**: Open Hardware Initiative Development Team

‎Source code/README.md‎

Lines changed: 27 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ This directory contains the source code for the Open Hardware Initiative website
44

55
## 🚀 Quick Start
66

7+
For a complete setup guide, see the **[Quick Start Guide](../docs/quick-start.md)**.
8+
79
### Prerequisites
810
- [Bun](https://bun.sh/) (recommended) or Node.js 18+
911
- Git
@@ -40,6 +42,8 @@ The GitHub Actions workflow (`.github/workflows/deploy.yml`) handles:
4042
- Building the project
4143
- Deploying to GitHub Pages
4244

45+
For detailed deployment information, see the **[Deployment Guide](../docs/deployment.md)**.
46+
4347
## 📁 Project Structure
4448

4549
```
@@ -67,54 +71,14 @@ data/ # Content data (TypeScript files)
6771

6872
## 📝 Content Management
6973

70-
### Adding/Editing Team Members
71-
Edit `src/data/peopleData.ts`:
72-
```typescript
73-
export const peopleData = [
74-
{
75-
name: "John Doe",
76-
role: "Team Member",
77-
image: "/media/team/john-doe.jpg",
78-
// ... other fields
79-
}
80-
];
81-
```
74+
For detailed content management instructions, see the **[Content Management Guide](../docs/content-management.md)**.
8275

83-
### Adding/Editing Projects
84-
Edit `src/data/projectsData.ts`:
85-
```typescript
86-
export const projectsData = [
87-
{
88-
title: "Project Name",
89-
description: "Project description",
90-
image: "/media/projects/project.jpg",
91-
// ... other fields
92-
}
93-
];
94-
```
76+
### Quick Reference
9577

96-
### Adding/Editing Events
97-
Edit `src/data/eventsData.ts`:
98-
```typescript
99-
export const eventsData = [
100-
{
101-
title: "Event Name",
102-
date: "2024-01-15",
103-
description: "Event description",
104-
// ... other fields
105-
}
106-
];
107-
```
108-
109-
### Managing Application Status
110-
Edit `src/config/applicationConfig.ts`:
111-
```typescript
112-
export const applicationConfig = {
113-
isOpen: false, // Set to true to enable applications
114-
formUrl: "https://forms.google.com/your-form", // Google Form URL
115-
closedMessage: "Application period is currently closed."
116-
};
117-
```
78+
**Team Members**: Edit `src/data/peopleData.ts`
79+
**Projects**: Edit `src/data/projectsData.ts`
80+
**Events**: Edit `src/data/eventsData.ts`
81+
**Application Status**: Edit `src/config/applicationConfig.ts`
11882

11983
## 🛠️ Tech Stack
12084

@@ -159,6 +123,8 @@ The website is fully responsive and mobile-friendly. All components are designed
159123

160124
## 🐛 Troubleshooting
161125

126+
For common issues and solutions, see the **[Troubleshooting Guide](../docs/troubleshooting.md)**.
127+
162128
### Common Issues
163129

164130
1. **Port already in use**: Change the port in `vite.config.ts`
@@ -167,6 +133,20 @@ The website is fully responsive and mobile-friendly. All components are designed
167133

168134
### Getting Help
169135

170-
- Check the [main README.md](../README.md) for repository overview
136+
- Check the **[Documentation Index](../docs/README.md)** for comprehensive guides
171137
- Create an issue in the repository for bugs
172138
- Contact the development team for questions
139+
140+
## 📚 Documentation
141+
142+
For complete documentation, see the **[docs/](../docs/README.md)** directory:
143+
144+
- **[Quick Start Guide](../docs/quick-start.md)** - Getting started
145+
- **[Content Management](../docs/content-management.md)** - Updating content
146+
- **[Deployment Guide](../docs/deployment.md)** - How deployment works
147+
- **[Troubleshooting](../docs/troubleshooting.md)** - Common problems and solutions
148+
149+
---
150+
151+
**Last Updated**: December 2024
152+
**Maintained by**: Open Hardware Initiative Development Team

‎docs/README.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Open Hardware Initiative Website Documentation
2+
3+
Welcome to the documentation for the Open Hardware Initiative website. This guide will help you understand, maintain, and update the website.
4+
5+
## 📚 Documentation Index
6+
7+
### 🚀 Getting Started
8+
- **[Quick Start Guide](quick-start.md)** - Get up and running in minutes
9+
- **[Project Overview](project-overview.md)** - Understanding the website structure and technology
10+
11+
### 🛠️ Development
12+
- **[Development Guide](development.md)** - Local development setup and workflow
13+
- **[Tech Stack](tech-stack.md)** - Technologies used and their purposes
14+
- **[Component Guide](components.md)** - Understanding React components and structure
15+
16+
### 📝 Content Management
17+
- **[Content Management Guide](content-management.md)** - How to update website content
18+
- **[Team Management](team-management.md)** - Adding/editing team members
19+
- **[Project Management](project-management.md)** - Adding/editing projects
20+
- **[Event Management](event-management.md)** - Adding/editing events
21+
- **[Application Management](application-management.md)** - Managing application forms and status
22+
23+
### 🚀 Deployment & Hosting
24+
- **[Deployment Guide](deployment.md)** - How the website is deployed and hosted
25+
- **[GitHub Actions](github-actions.md)** - Understanding the automated deployment workflow
26+
- **[Domain Configuration](domain-configuration.md)** - Custom domain setup and management
27+
28+
### 🔧 Configuration
29+
- **[Configuration Guide](configuration.md)** - Website settings and customization
30+
- **[Styling Guide](styling.md)** - CSS, Tailwind, and design system
31+
- **[SEO & Performance](seo-performance.md)** - Search engine optimization and performance
32+
33+
### 🐛 Troubleshooting
34+
- **[Common Issues](troubleshooting.md)** - Solutions to common problems
35+
- **[Debug Guide](debugging.md)** - How to debug issues
36+
37+
## 🎯 Quick Links
38+
39+
- **Live Website**: [open-hardware-initiative.com](https://open-hardware-initiative.com)
40+
- **GitHub Repository**: [OpenHardware-Initiative/OpenHardware-Initiative.github.io](https://github.com/OpenHardware-Initiative/OpenHardware-Initiative.github.io)
41+
- **GitHub Actions**: [Workflow runs](https://github.com/OpenHardware-Initiative/OpenHardware-Initiative.github.io/actions)
42+
43+
## 📞 Support
44+
45+
If you need help:
46+
1. Check the relevant documentation section above
47+
2. Look at the [troubleshooting guide](troubleshooting.md)
48+
3. Create an issue in the GitHub repository
49+
4. Contact the development team
50+
51+
## 🔄 Contributing
52+
53+
To contribute to the documentation:
54+
1. Make your changes in the appropriate `.md` file
55+
2. Test your changes locally
56+
3. Submit a pull request
57+
4. Wait for review and approval
58+
59+
---
60+
61+
**Last Updated**: December 2024
62+
**Maintained by**: Open Hardware Initiative Development Team

0 commit comments

Comments
 (0)