Skip to content

Commit 9091fc4

Browse files
committed
Update CONTRIBUTING.md with recent project structure changes
- Add v2me, projects, and xanga/applets directories to project structure - Add XangaLayoutWrapper component documentation - Add v2me.json and v2me.ts to data and lib sections - Update tech stack with react-markdown and @dnd-kit dependencies - Add Open Sans font optimization to tech stack - V2ME framework content management already documented
1 parent b0cdaa1 commit 9091fc4

1 file changed

Lines changed: 20 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ This is a personal website, but if you have suggestions or find issues, feel fre
1515
- **Language**: TypeScript
1616
- **Styling**: Tailwind CSS
1717
- **Icons**: react-icons
18-
- **Content**: Markdown with remark
18+
- **Content**: Markdown with remark and react-markdown
19+
- **Drag & Drop**: @dnd-kit (for V2ME reordering)
20+
- **Fonts**: Next.js Font Optimization (Open Sans)
1921

2022
## Project Structure
2123

@@ -25,36 +27,43 @@ tom-bohn.github.io/
2527
│ ├── about/ # About page
2628
│ ├── blog/ # Blog listing and posts
2729
│ │ └── [slug]/ # Dynamic blog post pages
28-
│ ├── certifications/ # Certifications page
30+
│ ├── certifications/ # Certifications/Learning page
2931
│ ├── contact/ # Contact page
3032
│ ├── hub/ # Hub page
3133
│ ├── links/ # Links page
3234
│ ├── projects/ # Projects page
35+
│ ├── v2me/ # V2ME framework page
3336
│ ├── layout.tsx # Root layout
3437
│ ├── page.tsx # Home page
3538
│ ├── not-found.tsx # 404 page
3639
│ └── globals.css # Global styles
3740
├── components/ # React components
3841
│ ├── hub/ # Hub-related components
3942
│ ├── links/ # Links-related components
43+
│ ├── projects/ # Projects-related components
44+
│ ├── v2me/ # V2ME framework components
4045
│ ├── xanga/ # Xanga theme components
46+
│ │ └── applets/ # Xanga sidebar applets
4147
│ ├── Footer.tsx # Site footer
4248
│ ├── Header.tsx # Site header/navigation
4349
│ ├── ThemeProvider.tsx # Theme context provider
44-
│ └── XangaShell.tsx # Xanga theme shell
50+
│ ├── XangaShell.tsx # Xanga theme shell
51+
│ └── XangaLayoutWrapper.tsx # Xanga sidebar state management
4552
├── lib/ # Utility functions
4653
│ ├── blog.ts # Blog post utilities
4754
│ ├── certifications.ts # Certification utilities
4855
│ ├── hub.ts # Hub utilities
4956
│ ├── links.ts # Links utilities
50-
│ └── projects.ts # Projects utilities
57+
│ ├── projects.ts # Projects utilities
58+
│ └── v2me.ts # V2ME framework utilities
5159
├── data/ # JSON data files
5260
│ ├── badges/ # Badge data (Credly, Accredible, Trailhead)
5361
│ ├── hub/ # Hub configuration
5462
│ ├── learning/ # Learning data
5563
│ ├── certifications.json
5664
│ ├── links.json
57-
│ └── projects.json
65+
│ ├── projects.json
66+
│ └── v2me.json # V2ME framework data
5867
├── content/ # Markdown content
5968
│ └── blog/ # Blog posts
6069
├── scripts/ # Build and data scripts
@@ -99,6 +108,12 @@ tom-bohn.github.io/
99108
- Edit `data/hub/hub.json`
100109
- Add link objects for your online presence
101110

111+
### V2ME Framework
112+
- Edit `data/v2me.json`
113+
- Structure includes: `vision`, `values`, `methods`, `obstacles`, `measures`
114+
- Each item has: `id`, `title`, `description` (and `completed` for methods/measures)
115+
- Can be edited in the UI and exported/imported as JSON
116+
102117
## Building for Production
103118

104119
```bash

0 commit comments

Comments
 (0)