Skip to content

Commit 9a9329b

Browse files
📝 docs: update documentation
1 parent acb33f8 commit 9a9329b

1 file changed

Lines changed: 105 additions & 24 deletions

File tree

README.md

Lines changed: 105 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,17 @@ MMSWE is an open-source platform where Myanmar software engineers can showcase t
3232

3333
## Tech Stack
3434

35-
| Layer | Technology |
36-
|-------|-----------|
37-
| **Framework** | Next.js 16 (App Router, Static Export) |
38-
| **Language** | TypeScript, React 19 |
39-
| **Styling** | Tailwind CSS 3 + DaisyUI + Sass |
40-
| **Content** | Contentlayer2 with MDX |
41-
| **Animation** | Framer Motion, Three.js, React Three Fiber |
42-
| **i18n** | next-intl (Myanmar & English) |
43-
| **Fonts** | Bricolage Grotesque, Plus Jakarta Sans, JetBrains Mono, KhitHaungg (Myanmar) |
44-
| **Package Manager** | Bun |
45-
| **Deployment** | GitHub Pages via GitHub Actions |
35+
| Layer | Technology |
36+
| ------------------- | ---------------------------------------------------------------------------- |
37+
| **Framework** | Next.js 16 (App Router, Static Export) |
38+
| **Language** | TypeScript, React 19 |
39+
| **Styling** | Tailwind CSS 3 + DaisyUI + Sass |
40+
| **Content** | Contentlayer2 with MDX |
41+
| **Animation** | Framer Motion, Three.js, React Three Fiber |
42+
| **i18n** | next-intl (Myanmar & English) |
43+
| **Fonts** | Bricolage Grotesque, Plus Jakarta Sans, JetBrains Mono, KhitHaungg (Myanmar) |
44+
| **Package Manager** | Bun |
45+
| **Deployment** | GitHub Pages via GitHub Actions |
4646

4747
## Quick Start
4848

@@ -119,12 +119,93 @@ Hello! I'm a software engineer from Myanmar...
119119

120120
### Frontmatter Fields
121121

122-
| Field | Required | Description |
123-
|-------|----------|-------------|
124-
| `name` | Yes | Your display name |
125-
| `description` | No | Short bio (shown on profile card) |
126-
| `image` | No | Avatar URL (GitHub avatar recommended) |
127-
| `tags` | No | Technology/skill tags |
122+
| Field | Required | Description |
123+
| ------------- | -------- | -------------------------------------- |
124+
| `name` | Yes | Your display name |
125+
| `description` | No | Short bio (shown on profile card) |
126+
| `image` | No | Avatar URL (GitHub avatar recommended) |
127+
| `tags` | No | Technology/skill tags |
128+
129+
## Add Your Book
130+
131+
1. **Fork** this repository
132+
2. Create a new file in `content/books/`:
133+
134+
```
135+
content/books/your-book-title.mdx
136+
```
137+
138+
3. Add frontmatter and content:
139+
140+
```mdx
141+
---
142+
title: book title
143+
authorName: the name of book author
144+
link: https://example.com/book-link
145+
image: https://example.com/book-cover.jpg
146+
authorEmail: author@example.com
147+
authorLink: https://example.com
148+
---
149+
150+
Short note about why this book is recommended.
151+
```
152+
153+
4. **Submit a Pull Request** to the `main` branch
154+
155+
### Frontmatter Fields
156+
157+
| Field | Required | Description |
158+
| ------------- | -------- | ------------------------------ |
159+
| `title` | Yes | Book title |
160+
| `authorName` | Yes | Author name |
161+
| `link` | Yes | Official/primary resource link |
162+
| `image` | No | Book cover image URL |
163+
| `authorEmail` | No | Author contact email |
164+
| `authorLink` | No | Author website/profile URL |
165+
166+
## Add Your Class
167+
168+
1. **Fork** this repository
169+
2. Create a new file in `content/classes/`:
170+
171+
```
172+
content/classes/your-class-title.mdx
173+
```
174+
175+
3. Add frontmatter and content:
176+
177+
```mdx
178+
---
179+
title: your class title
180+
description: short description of your class
181+
instructorName: class mentor name
182+
classLink: https://example.com/classes/react-bootcamp
183+
tags: tags for tech-stack that involve in this class
184+
classType: online or in-person
185+
status: upcoming/completed/incoming
186+
proofOfAssociation: Proof that submitter is affiliated with the class.
187+
image: https://example.com/class-cover.jpg
188+
---
189+
190+
Add trust context, schedule notes, and useful details for learners.
191+
This is important because PR without trust context for class will be denied.
192+
```
193+
194+
4. **Submit a Pull Request** to the `main` branch
195+
196+
### Frontmatter Fields
197+
198+
| Field | Required | Description |
199+
| -------------------- | -------- | ----------------------------------------- |
200+
| `title` | Yes | Class title |
201+
| `description` | Yes | Summary of class content |
202+
| `instructorName` | Yes | Instructor or organization |
203+
| `classLink` | Yes | Official class link |
204+
| `tags` | Yes | Topic tags (e.g. React, Python) |
205+
| `classType` | Yes | One of: `online`, `In-Person` |
206+
| `status` | Yes | One of: `active`, `completed`, `incoming` |
207+
| `proofOfAssociation` | Yes | Credibility/proof note for maintainers |
208+
| `image` | No | Class cover image URL |
128209

129210
## Project Structure
130211

@@ -161,14 +242,14 @@ messages/
161242

162243
MMSWE uses the **Obsidian Prism** theme — a dark interface with prismatic accent colors:
163244

164-
| Token | Color | Usage |
165-
|-------|-------|-------|
166-
| `obsidian` | `#09090b` | Base background |
167-
| `surface` | `#1a1a22` | Card backgrounds |
168-
| `prism-cyan` | `#22d3ee` | Primary accent |
245+
| Token | Color | Usage |
246+
| -------------- | --------- | ---------------- |
247+
| `obsidian` | `#09090b` | Base background |
248+
| `surface` | `#1a1a22` | Card backgrounds |
249+
| `prism-cyan` | `#22d3ee` | Primary accent |
169250
| `prism-violet` | `#a78bfa` | Secondary accent |
170-
| `prism-rose` | `#fb7185` | Tertiary accent |
171-
| `accent-gold` | `#fbbf24` | Highlight accent |
251+
| `prism-rose` | `#fb7185` | Tertiary accent |
252+
| `accent-gold` | `#fbbf24` | Highlight accent |
172253

173254
Typography uses **Bricolage Grotesque** for display, **Plus Jakarta Sans** for body, **JetBrains Mono** for code, and **KhitHaungg** for Myanmar script.
174255

0 commit comments

Comments
 (0)