Skip to content

Commit 478ca4d

Browse files
committed
Refactor audience sections in slides: update audience interfaces and enhance clarity with additional details
1 parent ef0a89d commit 478ca4d

File tree

1 file changed

+99
-8
lines changed

1 file changed

+99
-8
lines changed

introduction-to-codebase-interface/slides.md

Lines changed: 99 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ graph TD
1616
CONTRIBUTING["👥 CONTRIBUTING.md<br/><small>Contributor Interface</small>"]
1717
RUNBOOK["🔧 RUNBOOK.md<br/><small>Operations Interface</small>"]
1818
AGENTS["🤖 AGENTS.md<br/><small>AI Interface</small>"]
19-
BUILD["⚙️ Taskfile<br/><small>Build Interface</small>"]
19+
BUILD["⚙️ CLI<br/><small>Build Interface</small>"]
2020
2121
%% Audience Groups
2222
USERS["👤 Service Users<br/><small>End Users</small>"]
@@ -51,23 +51,114 @@ graph TD
5151

5252
---
5353

54-
## Vertical Slides
54+
## Audiences
5555

56-
Press down arrow for more
56+
Codebases have multiple audiences each requiring a tailored interface for their needs:
57+
58+
- Service Users
59+
- Contributors
60+
- Operators
61+
- AI Agents
62+
- Build Agents
63+
64+
--
65+
66+
## Service Users
67+
68+
Users of the service typically interact with the codebase through the **README.md** file.
69+
70+
```mermaid
71+
graph TD
72+
USERS["👤 Service Users<br/><small>End Users</small>"]
73+
README["📖 README.md<br/><small>User Interface</small>"]
74+
LANGUAGE["📚 LANGUAGE.md<br/><small>Ubiquitous Language</small>"]
75+
CHANGELOG["📜 CHANGELOG.md<br/><small>Release Notes</small>"]
76+
SUPPORT["🆘 SUPPORT.md<br/><small>Support Information</small>"]
77+
78+
USERS ==> README
79+
README ==> LANGUAGE
80+
README ==> CHANGELOG
81+
README ==> SUPPORT
82+
```
83+
84+
--
85+
86+
## Contributors
87+
88+
Contributors to the codebase typically interact through the **CONTRIBUTING.md** file.
89+
90+
```mermaid
91+
graph TD
92+
CONTRIBUTORS["🧑‍💻 Contributors<br/><small>Developers</small>"]
93+
CONTRIBUTING["👥 CONTRIBUTING.md<br/><small>Contributor Interface</small>"]
94+
ISSUE_TEMPLATE["📝 ISSUE_TEMPLATE.md<br/><small>Issue Reporting</small>"]
95+
PULL_REQUEST_TEMPLATE["🔄 PULL_REQUEST_TEMPLATE.md<br/><small>Pull Request Process</small>"]
96+
README["📖 README.md<br/><small>User Interface</small>"]
97+
LANGUAGE["📚 LANGUAGE.md<br/><small>Ubiquitous Language</small>"]
98+
CHANGELOG["📜 CHANGELOG.md<br/><small>Release Notes</small>"]
99+
SUPPORT["🆘 SUPPORT.md<br/><small>Support Information</small>"]
100+
101+
CONTRIBUTORS ==> CONTRIBUTING
102+
CONTRIBUTING ==> README
103+
CONTRIBUTING ==> LANGUAGE
104+
CONTRIBUTING ==> SUPPORT
105+
CONTRIBUTING ==> CHANGELOG
106+
CONTRIBUTING ==> ISSUE_TEMPLATE
107+
CONTRIBUTING ==> PULL_REQUEST_TEMPLATE
108+
```
57109

58110
--
59111

60-
## Nested Slide 1
112+
## Operators
61113

62-
You can create vertical slide stacks
114+
Operators of the codebase typically interact through the **RUNBOOK.md** file.
63115

64-
Use `--` to separate slides vertically.
116+
```mermaid
117+
graph TD
118+
OPERATORS["🛠️ Operators<br/><small>DevOps/SRE</small>"]
119+
RUNBOOK["📖 RUNBOOK.md<br/><small>Operational Procedures</small>"]
120+
SUPPORT["🆘 SUPPORT.md<br/><small>Support Information</small>"]
121+
CHANGELOG["📜 CHANGELOG.md<br/><small>Release Notes</small>"]
122+
123+
OPERATORS ==> RUNBOOK
124+
RUNBOOK ==> SUPPORT
125+
RUNBOOK ==> CHANGELOG
126+
127+
```
65128

66129
--
67130

68-
## Nested Slide 2
131+
## AI Agents
132+
133+
AI Agents typically interact with the codebase through the **AGENTS.md** file.
134+
135+
```mermaid
136+
graph TD
137+
AI_AGENTS["🤖 AI Agents<br/><small>Automated Systems</small>"]
138+
AGENTS["📖 AGENTS.md<br/><small>Agent Interface</small>"]
69139
70-
Navigate with arrow keys
140+
AI_AGENTS ==> AGENTS
141+
142+
```
143+
144+
--
145+
146+
## Build Agents
147+
148+
Build Agents typically interact with the codebase through the a build file and a CLI.
149+
150+
```mermaid
151+
graph TD
152+
BUILD_AGENTS["🛠️ Build Agents<br/><small>CI/CD Systems</small>"]
153+
BUILD_FILE["📖 BUILD<br/><small>Build Configuration</small>"]
154+
CLI["🖥️ CLI<br/><small>Command Line Interface</small>"]
155+
DIRECTORY["📁 DIRECTORY<br/><small>File Structure</small>"]
156+
157+
BUILD_AGENTS ==> BUILD_FILE
158+
BUILD_AGENTS ==> CLI
159+
BUILD_AGENTS ==> DIRECTORY
160+
161+
```
71162

72163
---
73164

0 commit comments

Comments
 (0)