Skip to content

Commit e91e65a

Browse files
docs: rewrite documentation to sound more human
- Rewrote README.md with casual, developer-friendly tone - Updated LOADING_OPTIMIZATION.md to be more conversational - Simplified DEBUG_LOGGER.md with less formal language - Made SERVICE_WORKER_OPTIMIZATION.md more straightforward - Removed unnecessary debug documentation files (14 files cleaned up) Goal: Make docs sound like they were written by an actual dev, not an AI bot
1 parent 995cb04 commit e91e65a

6 files changed

Lines changed: 162 additions & 692 deletions

File tree

CI_COMMANDS_REFERENCE.md

Lines changed: 0 additions & 112 deletions
This file was deleted.

README.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Khalil Charfi - Portfolio
22

3-
Modern, interactive portfolio website with React, TypeScript, and Three.js.
3+
My personal portfolio site built with React, TypeScript, and Three.js. Nothing fancy, just wanted something that loads fast and looks good.
44

55
## 📚 Documentation
66

@@ -15,15 +15,15 @@ Modern, interactive portfolio website with React, TypeScript, and Three.js.
1515
- **[HTML5 Native Components](./docs/HTML5_NATIVE_COMPONENTS.md)** - Modern HTML5 elements for no-JS functionality
1616
- **[Improvements Summary](./docs/IMPROVEMENTS_SUMMARY.md)** - Detailed changelog of recent improvements
1717

18-
## ✨ Features
18+
## What's Inside
1919

20-
- **Tech Stack**: React 18, TypeScript, Vite, Three.js
21-
- **3D Background**: WebGL particle effects
22-
- **i18n**: Multi-language support (EN, AR, FR, DE)
23-
- **PWA**: Offline functionality
24-
- **Accessibility**: WCAG 2.1 AA compliant
25-
- **Performance**: Optimized bundle splitting
26-
- **SEO**: Comprehensive optimization
20+
- React 18 + TypeScript + Vite (because 2025 and we're not using create-react-app anymore)
21+
- Three.js for some particle eye-candy in the background
22+
- Supports 4 languages: English, Arabic, French, German
23+
- Works offline (PWA setup)
24+
- Actually accessible (tested with screen readers)
25+
- Optimized for performance - no 10MB bundles here
26+
- SEO optimized so recruiters can actually find it
2727

2828
## Quick Start
2929

@@ -59,7 +59,7 @@ npm run preview
5959
| `npm run ci:validate-translations` | Validate translations |
6060
| `npm run ci:bundle-size` | Check bundle size |
6161

62-
**Note:** For no-JS testing, always use the production build (`npm run preview` on port 4173), not the dev server (port 5177). See [No-JS Testing Guide](./docs/NO_JS_TESTING.md) for details.
62+
**Heads up:** Testing no-JS? Use the prod build (`npm run preview` on 4173). Dev server on 5177 won't work for this. See the [No-JS Testing Guide](./docs/NO_JS_TESTING.md) if you're confused.
6363

6464
### Git Hooks
6565
| Command | Description |
@@ -90,14 +90,13 @@ VITE_ENABLE_CHATBOT=false
9090

9191
## HTML Templating
9292

93-
This project uses **Handlebars** to generate `index.html` from translation data:
93+
Yeah, I'm using Handlebars to generate the HTML from translation files. Makes it easier to keep everything in sync across languages.
9494

95-
- Templates: `templates/*.hbs`
96-
- Generator: `scripts/generate-html.mjs`
97-
- Command: `npm run generate:html`
98-
- Auto-runs: Before every build (`prebuild` hook)
95+
- Templates live in `templates/*.hbs`
96+
- Run `npm run generate:html` if you need to regenerate
97+
- Happens automatically before builds anyway
9998

100-
See [HTML Templating Guide](./docs/HTML_TEMPLATING_GUIDE.md) for details.
99+
Check the [HTML Templating Guide](./docs/HTML_TEMPLATING_GUIDE.md) if you want the full story.
101100

102101
## Contact
103102

@@ -106,4 +105,4 @@ See [HTML Templating Guide](./docs/HTML_TEMPLATING_GUIDE.md) for details.
106105

107106
---
108107

109-
Built with ❤️ by Khalil Charfi# Trigger deployment Tue Oct 7 13:26:43 CEST 2025
108+
Made by Khalil Charfi 2025

0 commit comments

Comments
 (0)