Skip to content

Commit 102225d

Browse files
Merge pull request #64 from WebDevSimplified/javascript-interview-questions
Add JS Interview Article and AI Docs
2 parents 8b8703f + 82d06ed commit 102225d

16 files changed

+4472
-2
lines changed

docs/README.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Web Dev Simplified Blog - Documentation
2+
3+
## Quick Navigation
4+
5+
This documentation is organized into focused modules for efficient reference:
6+
7+
- **[README.md](README.md)** - This overview and quick start guide
8+
- **[project-overview.md](project-overview.md)** - Technology stack and architecture
9+
- **[article-creation-guide.md](article-creation-guide.md)** - Complete guide for creating new articles
10+
- **[component-development-guide.md](component-development-guide.md)** - Building interactive components
11+
- **[styling-and-theming.md](styling-and-theming.md)** - CSS system and theming guide
12+
- **[build-and-deployment.md](build-and-deployment.md)** - Build process and deployment
13+
- **[content-management.md](content-management.md)** - Tags, search, RSS, and content organization
14+
- **[troubleshooting.md](troubleshooting.md)** - Common issues and solutions
15+
- **[advanced-features.md](advanced-features.md)** - Analytics, performance, and accessibility
16+
17+
## Project Overview
18+
19+
The Web Dev Simplified Blog is a static site built with Astro that focuses on web development education. The blog follows a strict Monday release schedule and is designed to provide high-quality technical content with interactive examples and comprehensive explanations.
20+
21+
### Key Characteristics
22+
23+
- **Release Schedule**: Articles are published every Monday (all dates in the codebase follow this pattern)
24+
- **Content Focus**: Web development tutorials, explanations, and technical discussions
25+
- **Interactive Learning**: Heavy use of interactive components to demonstrate concepts
26+
- **Author**: Kyle Cook (default author for all posts)
27+
- **Target Audience**: Web developers of all skill levels
28+
29+
## Quick Start
30+
31+
### Development Setup
32+
33+
```bash
34+
# Install dependencies
35+
npm install
36+
37+
# Start development server
38+
npm run dev
39+
40+
# Build for production
41+
npm run build
42+
```
43+
44+
### Creating a New Article
45+
46+
1. Create directory: `src/pages/YYYY-MM/article-slug/`
47+
2. Add `index.mdx` with proper frontmatter
48+
3. Ensure date is a Monday
49+
4. Add interactive components as needed
50+
51+
### Most Common Tasks
52+
53+
- **New Article**: See [article-creation-guide.md](article-creation-guide.md)
54+
- **Interactive Component**: See [component-development-guide.md](component-development-guide.md)
55+
- **Styling Issues**: See [styling-and-theming.md](styling-and-theming.md)
56+
- **Build Problems**: See [troubleshooting.md](troubleshooting.md)
57+
58+
## Architecture Summary
59+
60+
- **Static Site Generator**: Astro with component islands
61+
- **Content Format**: MDX (Markdown + JSX)
62+
- **Interactive Components**: React (only where needed)
63+
- **Styling**: CSS custom properties with theming
64+
- **Deployment**: Netlify with automatic builds
65+
66+
For detailed information, see the specific documentation files linked above.

0 commit comments

Comments
 (0)