Skip to content

Commit 72a9bf8

Browse files
committed
feat: Improve visual hierarchy and fix navigation links - IMPROVEMENT 1: Visual Hierarchy & Content Structure - Converted Quick Navigation section to card-based grid layout - Converted Key Features section to card-based grid layout with hover effects - Cards provide better visual scanning and engagement - Improved spacing and visual separation between sections - Enhanced CSS with stronger overrides for theme compatibility - IMPROVEMENT 2: Fix Broken Navigation Links - Replaced Python file links (.py) with GitHub repository links - All tool links now point to actual GitHub file locations - Documentation links use proper .html extensions for GitHub Pages - Removed redundant Live Site section - All navigation links are now functional on GitHub Pages
1 parent 3a28f0d commit 72a9bf8

2 files changed

Lines changed: 137 additions & 85 deletions

File tree

assets/css/style.css

Lines changed: 47 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -157,22 +157,23 @@ a:hover {
157157
/* Buttons */
158158
.btn {
159159
display: inline-block;
160-
padding: 0.75rem 1.5rem;
161-
background: linear-gradient(135deg, var(--primary-color), var(--secondary-color));
162-
color: white;
160+
padding: 0.75rem 1.5rem !important;
161+
background: linear-gradient(135deg, var(--primary-color), var(--secondary-color)) !important;
162+
color: white !important;
163163
border: none;
164164
border-radius: 6px;
165165
font-weight: 600;
166166
text-decoration: none;
167167
transition: all 0.3s;
168168
box-shadow: var(--shadow);
169+
margin: 0.5rem;
169170
}
170171

171172
.btn:hover {
172173
transform: translateY(-2px);
173174
box-shadow: var(--shadow-lg);
174-
text-decoration: none;
175-
color: white;
175+
text-decoration: none !important;
176+
color: white !important;
176177
}
177178

178179
/* Code Blocks */
@@ -254,30 +255,46 @@ li {
254255

255256
/* Features Section */
256257
.features {
257-
display: grid;
258-
grid-template-columns: repeat(auto-fit, minmax(250px, 1fr));
259-
gap: 1.5rem;
260-
margin: 2rem 0;
258+
display: grid !important;
259+
grid-template-columns: repeat(auto-fit, minmax(280px, 1fr)) !important;
260+
gap: 1.5rem !important;
261+
margin: 2rem 0 !important;
261262
}
262263

263264
.feature-card {
264-
background: white;
265-
border: 1px solid var(--border-color);
266-
border-radius: 8px;
267-
padding: 1.5rem;
265+
background: white !important;
266+
border: 1px solid var(--border-color) !important;
267+
border-radius: 8px !important;
268+
padding: 1.5rem !important;
268269
text-align: center;
269270
transition: all 0.3s;
271+
box-shadow: var(--shadow);
272+
min-height: 200px;
273+
display: flex;
274+
flex-direction: column;
270275
}
271276

272277
.feature-card:hover {
273278
transform: translateY(-4px);
274-
box-shadow: var(--shadow-lg);
275-
border-color: var(--primary-color);
279+
box-shadow: var(--shadow-lg) !important;
280+
border-color: var(--primary-color) !important;
276281
}
277282

278283
.feature-card h3 {
279-
color: var(--primary-color);
280-
margin-top: 0;
284+
color: var(--primary-color) !important;
285+
margin-top: 0 !important;
286+
border: none !important;
287+
font-size: 1.25rem !important;
288+
}
289+
290+
.feature-card ul {
291+
margin: 1rem 0 !important;
292+
flex-grow: 1;
293+
}
294+
295+
.feature-card li {
296+
margin: 0.75rem 0 !important;
297+
line-height: 1.6;
281298
}
282299

283300
/* Footer */
@@ -324,25 +341,28 @@ li {
324341

325342
/* Hero Section */
326343
.hero {
327-
background: linear-gradient(135deg, var(--primary-color) 0%, var(--secondary-color) 100%);
328-
color: white;
329-
padding: 4rem 1rem;
344+
background: linear-gradient(135deg, var(--primary-color) 0%, var(--secondary-color) 100%) !important;
345+
color: white !important;
346+
padding: 4rem 1rem !important;
330347
text-align: center;
331-
margin: -2rem -1rem 3rem -1rem;
348+
margin: -2rem -1rem 3rem -1rem !important;
349+
border-radius: 0;
332350
}
333351

334352
.hero h1 {
335-
color: white;
336-
border: none;
337-
font-size: 3rem;
338-
margin-bottom: 1rem;
353+
color: white !important;
354+
border: none !important;
355+
font-size: 3rem !important;
356+
margin-bottom: 1rem !important;
357+
padding-bottom: 0 !important;
339358
}
340359

341360
.hero p {
342-
font-size: 1.3rem;
361+
font-size: 1.3rem !important;
343362
opacity: 0.95;
344363
max-width: 800px;
345-
margin: 0 auto;
364+
margin: 1rem auto !important;
365+
color: white !important;
346366
}
347367

348368
/* Badge/Pill */

index.md

Lines changed: 90 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -20,60 +20,100 @@ Learn to speak AI's language. Turn vague requests into precise instructions that
2020

2121
## Quick Navigation
2222

23-
### Documentation
24-
- **[Quick Start Guide](docs/QUICK_START.md)** - Get started in minutes
25-
- **[API Reference](docs/API_REFERENCE.md)** - Complete tool documentation
26-
- **[Troubleshooting](docs/TROUBLESHOOTING.md)** - Common issues and solutions
27-
28-
### Course Materials
29-
- **[Course Overview](course_overview.md)** - Full curriculum
30-
- **[Course Roadmap](COURSE_ROADMAP.md)** - Learning path
31-
- **[Foundations Lab](foundations_lab.md)** - First interactive lab
32-
- **[Start Here](START_HERE.md)** - Getting started guide
33-
34-
### Tools & Resources
35-
- **[Interactive Dashboard](streamlit_app.py)** - Run with `streamlit run streamlit_app.py`
36-
- **[Prompt Validator](notebooks/prompt_validator.py)** - Score prompts 0-100%
37-
- **[Production Validator](notebooks/production_validator.py)** - Production testing
38-
- **[A/B Testing](notebooks/ab_testing_framework.py)** - Compare prompt versions
39-
- **[Progress Tracker](notebooks/progress_tracker.py)** - Track learning
40-
41-
### Community
42-
- **[Contributing Guide](CONTRIBUTING.md)** - How to contribute
43-
- **[GitHub Repository](https://github.com/ElaMCB/AI-Prompt-Engineering)** - Source code
44-
- **[Improvements Summary](IMPROVEMENTS_SUMMARY.md)** - Recent enhancements
23+
<div class="features">
24+
25+
<div class="feature-card">
26+
<h3>Documentation</h3>
27+
<ul style="text-align: left; padding-left: 1.5rem;">
28+
<li><a href="docs/QUICK_START.html">Quick Start Guide</a> - Get started in minutes</li>
29+
<li><a href="docs/API_REFERENCE.html">API Reference</a> - Complete tool documentation</li>
30+
<li><a href="docs/TROUBLESHOOTING.html">Troubleshooting</a> - Common issues and solutions</li>
31+
</ul>
32+
</div>
33+
34+
<div class="feature-card">
35+
<h3>Course Materials</h3>
36+
<ul style="text-align: left; padding-left: 1.5rem;">
37+
<li><a href="course_overview.html">Course Overview</a> - Full curriculum</li>
38+
<li><a href="COURSE_ROADMAP.html">Course Roadmap</a> - Learning path</li>
39+
<li><a href="foundations_lab.html">Foundations Lab</a> - First interactive lab</li>
40+
<li><a href="START_HERE.html">Start Here</a> - Getting started guide</li>
41+
</ul>
42+
</div>
43+
44+
<div class="feature-card">
45+
<h3>Tools & Resources</h3>
46+
<ul style="text-align: left; padding-left: 1.5rem;">
47+
<li><a href="https://github.com/ElaMCB/AI-Prompt-Engineering/blob/main/streamlit_app.py">Interactive Dashboard</a> - Run with <code>streamlit run streamlit_app.py</code></li>
48+
<li><a href="https://github.com/ElaMCB/AI-Prompt-Engineering/blob/main/notebooks/prompt_validator.py">Prompt Validator</a> - Score prompts 0-100%</li>
49+
<li><a href="https://github.com/ElaMCB/AI-Prompt-Engineering/blob/main/notebooks/production_validator.py">Production Validator</a> - Production testing</li>
50+
<li><a href="https://github.com/ElaMCB/AI-Prompt-Engineering/blob/main/notebooks/ab_testing_framework.py">A/B Testing</a> - Compare prompt versions</li>
51+
<li><a href="https://github.com/ElaMCB/AI-Prompt-Engineering/blob/main/notebooks/progress_tracker.py">Progress Tracker</a> - Track learning</li>
52+
</ul>
53+
</div>
54+
55+
<div class="feature-card">
56+
<h3>Community</h3>
57+
<ul style="text-align: left; padding-left: 1.5rem;">
58+
<li><a href="CONTRIBUTING.html">Contributing Guide</a> - How to contribute</li>
59+
<li><a href="https://github.com/ElaMCB/AI-Prompt-Engineering">GitHub Repository</a> - Source code</li>
60+
<li><a href="IMPROVEMENTS_SUMMARY.html">Improvements Summary</a> - Recent enhancements</li>
61+
</ul>
62+
</div>
63+
64+
</div>
4565

4666
---
4767

4868
## Key Features
4969

50-
### **Prompt Validator**
51-
Score prompts 0-100% using multi-factor weighted scoring:
52-
- Clarity (25%)
53-
- Specificity (25%)
54-
- Context (20%)
55-
- Structure (15%)
56-
- Examples (15%)
57-
58-
### **Production Validator**
59-
Test prompts for production deployment:
60-
- Consistency testing
61-
- Robustness with edge cases
62-
- Performance monitoring
63-
- Automated recommendations
64-
65-
### **Model-Agnostic LLM Support**
66-
Works with multiple providers:
67-
- OpenAI (GPT-3.5, GPT-4)
68-
- Anthropic (Claude 3)
69-
- Ollama (local models)
70-
71-
### **Interactive Dashboard**
72-
Use the Streamlit dashboard for:
73-
- Real-time prompt validation
74-
- LLM playground
75-
- A/B testing interface
76-
- Progress tracking
70+
<div class="features">
71+
72+
<div class="feature-card">
73+
<h3>Prompt Validator</h3>
74+
<p>Score prompts 0-100% using multi-factor weighted scoring:</p>
75+
<ul style="text-align: left; padding-left: 1.5rem;">
76+
<li>Clarity (25%)</li>
77+
<li>Specificity (25%)</li>
78+
<li>Context (20%)</li>
79+
<li>Structure (15%)</li>
80+
<li>Examples (15%)</li>
81+
</ul>
82+
</div>
83+
84+
<div class="feature-card">
85+
<h3>Production Validator</h3>
86+
<p>Test prompts for production deployment:</p>
87+
<ul style="text-align: left; padding-left: 1.5rem;">
88+
<li>Consistency testing</li>
89+
<li>Robustness with edge cases</li>
90+
<li>Performance monitoring</li>
91+
<li>Automated recommendations</li>
92+
</ul>
93+
</div>
94+
95+
<div class="feature-card">
96+
<h3>Model-Agnostic LLM Support</h3>
97+
<p>Works with multiple providers:</p>
98+
<ul style="text-align: left; padding-left: 1.5rem;">
99+
<li>OpenAI (GPT-3.5, GPT-4)</li>
100+
<li>Anthropic (Claude 3)</li>
101+
<li>Ollama (local models)</li>
102+
</ul>
103+
</div>
104+
105+
<div class="feature-card">
106+
<h3>Interactive Dashboard</h3>
107+
<p>Use the Streamlit dashboard for:</p>
108+
<ul style="text-align: left; padding-left: 1.5rem;">
109+
<li>Real-time prompt validation</li>
110+
<li>LLM playground</li>
111+
<li>A/B testing interface</li>
112+
<li>Progress tracking</li>
113+
</ul>
114+
</div>
115+
116+
</div>
77117

78118
---
79119

@@ -153,18 +193,10 @@ Use the Streamlit dashboard for:
153193

154194
---
155195

156-
## Live Site
157-
158-
Your GitHub Pages site: **https://elamcb.github.io/AI-Prompt-Engineering/**
159-
160-
- Auto-deployed from main branch
161-
- Documentation accessible online
162-
- Markdown rendering
163-
- Easy navigation
164196

165197
---
166198

167-
## 📝 License
199+
## License
168200

169201
MIT Licensed • Actively Maintained • Community Contributions Welcome
170202

0 commit comments

Comments
 (0)