Skip to content

Commit 9729b34

Browse files
committed
docs: update styles and content for mobile optimization and clarity in index.md and extra.css
1 parent bc320f3 commit 9729b34

File tree

3 files changed

+56
-18
lines changed

3 files changed

+56
-18
lines changed

.vscode/settings.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
"pymdown",
1515
"pymdownx",
1616
"RUNBOOK",
17+
"runbooks",
1718
"striptags",
1819
"superfences",
1920
"taskfile",

docs/assets/stylesheets/extra.css

Lines changed: 50 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,15 @@
1212
--ci-shadow-lg: 0 10px 15px -3px rgba(0, 0, 0, 0.1), 0 4px 6px -2px rgba(0, 0, 0, 0.05);
1313
}
1414

15-
/* Hero Section Styling */
15+
/* Hero Section Styling - Mobile Optimized */
1616
.hero-section {
1717
text-align: center;
18-
padding: 3rem 0;
19-
background: var(--ci-gradient);
20-
background-clip: text;
21-
-webkit-background-clip: text;
22-
color: transparent;
23-
margin-bottom: 2rem;
18+
padding: 1.5rem 0;
19+
margin-bottom: 1rem;
2420
}
2521

2622
.hero-section h2 {
27-
font-size: 2.5rem;
23+
font-size: 2rem;
2824
font-weight: 700;
2925
margin-bottom: 1rem;
3026
background: var(--ci-gradient);
@@ -34,13 +30,18 @@
3430
}
3531

3632
.hero-buttons {
37-
margin-top: 2rem;
33+
margin-top: 1.5rem;
3834
display: flex;
39-
gap: 1rem;
35+
gap: 0.75rem;
4036
justify-content: center;
4137
flex-wrap: wrap;
4238
}
4339

40+
.hero-buttons .md-button {
41+
padding: 0.6rem 1rem;
42+
font-size: 0.9rem;
43+
}
44+
4445
/* Interface Example Styling */
4546
.interface-example {
4647
background: var(--md-code-bg-color);
@@ -274,31 +275,67 @@
274275

275276
/* Mobile Responsiveness */
276277
@media (max-width: 768px) {
278+
.hero-section {
279+
padding: 1rem 0;
280+
margin-bottom: 0.5rem;
281+
}
282+
277283
.hero-section h2 {
278-
font-size: 2rem;
284+
font-size: 1.6rem;
285+
margin-bottom: 0.75rem;
279286
}
280287

281288
.hero-buttons {
282289
flex-direction: column;
283-
align-items: center;
290+
gap: 0.5rem;
291+
margin-top: 1rem;
284292
}
285293

286294
.hero-buttons .md-button {
287295
width: 100%;
288296
max-width: 300px;
297+
margin: 0 auto;
289298
}
290299

291300
.audience-grid,
292301
.principles-grid {
293302
grid-template-columns: 1fr;
303+
gap: 1rem;
294304
}
295305

296306
.stats-grid {
297307
grid-template-columns: repeat(2, 1fr);
298308
}
299309

300310
.cta-section {
301-
padding: 2rem 1rem;
311+
padding: 1.5rem 1rem;
312+
margin: 1.5rem 0;
313+
}
314+
315+
.interface-example {
316+
padding: 1.5rem;
317+
margin: 1rem 0;
318+
}
319+
320+
.principle-card {
321+
padding: 1.25rem;
322+
}
323+
}
324+
325+
/* Compact spacing for mobile */
326+
@media (max-width: 768px) {
327+
.md-typeset h1 {
328+
margin-bottom: 0.5rem;
329+
font-size: 1.8rem;
330+
}
331+
332+
.md-typeset h2 {
333+
margin-top: 1.5rem;
334+
margin-bottom: 0.75rem;
335+
}
336+
337+
.md-typeset hr {
338+
margin: 1rem 0;
302339
}
303340
}
304341

docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Codebase Interface - Promoting Ease of Use Across Languages and Frameworks
33
description: A comprehensive set of principles and tools that promote ease of use of codebases across languages, frameworks, and audiences. Explore documentation, CLI tools, templates, and implementation guides for contributors, consumers, operators, and AI agents.
4-
keywords: codebase interface, documentation standards, CLI tools, templates, automation, contributors, consumers, operators, AI agents, build agents, implementation guides, best practices, project structure, documentation generation, compliance validation, cross-platform, multi-language
4+
keywords: codebase interface, documentation standards, README, CONTRIBUTING, RUNBOOK, AGENTS, CLI tools, templates, automation, contributors, consumers, operators, AI agents, build agents, implementation guides, best practices, project structure, documentation generation, compliance validation, cross-platform, multi-language
55
hide:
66
- navigation
77
- toc
@@ -19,9 +19,9 @@ search:
1919

2020
<div class="hero-section" markdown>
2121

22-
## 🚀 Promoting Ease of Use of Codebases Across Languages and Frameworks
22+
## 🚀 Promoting Ease of Codebase Use for All Audiences
2323

24-
A **comprehensive set of principles** that promote ease of use of codebases across languages, frameworks, and multiple audiences.
24+
A **comprehensive set of principles** that promote ease of use codebase use across platforms, languages and IDEs for multiple audiences.
2525

2626
<div class="hero-buttons" markdown>
2727
[Comprehensive Docs →](https://codebaseinterface.org/docs){ .md-button .md-button--primary }
@@ -79,7 +79,7 @@ The principles apply across **programming languages and frameworks**, promoting
7979

8080
<div class="principle-card" markdown>
8181
### 🔧 Tool Integration
82-
Leverage common tools like **Taskfile**, `.editorconfig`, and conventional commits for better developer experience and automated quality assurance.
82+
Leverage common tools like **Taskfile**, `.editorconfig`, and conventional commits for better developer experience and streamlined contributing methods.
8383
</div>
8484

8585
<div class="principle-card" markdown>
@@ -117,7 +117,7 @@ A well-structured codebase serves **diverse audiences** with distinct needs. Adh
117117

118118
🖥️ **Anyone who runs a service in production**
119119

120-
Operational runbooks, deployment guides, monitoring setup, and troubleshooting documentation for production environments.
120+
Operational runbooks contain monitoring guides and troubleshooting documentation for production environments.
121121

122122
!!! warning "**AI Agents**"
123123

0 commit comments

Comments
 (0)