Skip to content

Commit 6b2d83f

Browse files
committed
feat: add interface example section with enhanced styling
1 parent f7185d7 commit 6b2d83f

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed

docs/assets/stylesheets/extra.css

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,39 @@
4141
flex-wrap: wrap;
4242
}
4343

44+
/* Interface Example Styling */
45+
.interface-example {
46+
background: var(--md-code-bg-color);
47+
border-radius: 12px;
48+
padding: 2rem;
49+
margin: 2rem 0;
50+
border-left: 4px solid var(--ci-primary);
51+
}
52+
53+
.interface-example .highlight {
54+
background: var(--md-default-bg-color);
55+
border-radius: 8px;
56+
margin: 1rem 0;
57+
border: 1px solid var(--md-default-fg-color--lightest);
58+
}
59+
60+
.interface-example pre {
61+
padding: 1.5rem;
62+
font-family: 'JetBrains Mono', 'Fira Code', 'Roboto Mono', monospace;
63+
font-size: 0.9rem;
64+
line-height: 1.6;
65+
}
66+
67+
.interface-example ul {
68+
margin-top: 1rem;
69+
padding-left: 1rem;
70+
}
71+
72+
.interface-example li {
73+
margin: 0.5rem 0;
74+
padding: 0.25rem 0;
75+
}
76+
4477
/* Grid Layouts */
4578
.audience-grid {
4679
display: grid;

docs/index.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,34 @@ A **comprehensive set of principles** that promote ease of use of codebases acro
110110

111111
---
112112

113+
## 📁 Interface Example
114+
115+
<div class="interface-example" markdown>
116+
117+
Here's what a codebase interface looks like in practice:
118+
119+
```
120+
my-project/
121+
├── 📖 README.md # User interface - how to use the project
122+
├── 🤝 CONTRIBUTING.md # Contributor interface - how to contribute
123+
├── 🖥️ RUNBOOK.md # Operator interface - how to deploy/operate
124+
├── 🤖 AGENTS.md # AI Agent interface - how agents should interact
125+
├── 📝 TODO.md # Outstanding tasks and roadmap
126+
├── 📋 Taskfile.yml # Unified task automation interface
127+
├── ⚙️ .editorconfig # Code formatting standards
128+
└── 📏 .gitattributes # Git handling rules
129+
```
130+
131+
**Key Benefits:**
132+
-**Predictable** - Same structure across all projects
133+
- 🚀 **Fast Onboarding** - New team members know exactly where to look
134+
- 🤖 **AI-Friendly** - Automated tools understand your project structure
135+
- 🔄 **Universal** - Works with any programming language or framework
136+
137+
</div>
138+
139+
---
140+
113141
## ⭐ Key Principles
114142

115143
<div class="principles-grid" markdown>

0 commit comments

Comments
 (0)