Skip to content

Commit dd338a4

Browse files
committed
fix: update Taskfile and mkdocs configuration for improved setup and mermaid support
1 parent 26e4358 commit dd338a4

File tree

3 files changed

+59
-2
lines changed

3 files changed

+59
-2
lines changed

Taskfile.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ tasks:
1919
- pip install mkdocs-git-revision-date-localized-plugin
2020
- pip install pymdown-extensions
2121
- echo "Setup complete! Changelog is automatically generated via GitHub Actions."
22+
- pip install mkdocs-mermaid2-plugin
2223
silent: true
2324

2425
build:

docs/README.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Welcome to the codebase interface initiative!
44

55
The codebase interface is a set of principles and practices that allow us to identify and understand all perspectives of interacting with a codebase, including contributors, users, operators, AI agents, and build agents.
66

7-
By providing specific interfaces for each audience perspective, we can ensure that everyone has a clean and maintainable experience when interacting with a codebase.
7+
By providing specific interfaces for each audience perspective, we can ensure that we help all users of the codebase by providing a great experience with clean and maintainable interfaces for all!
88

99
## Guide
1010

@@ -15,6 +15,57 @@ By providing specific interfaces for each audience perspective, we can ensure th
1515
- [Examples](./examples.md)
1616
- [Tooling](./tooling.md)
1717

18+
## Overview
19+
20+
Remember your codebase is a product with multiple users. We should treat it as such by providing great experiences for all audiences that interact with it.
21+
22+
## Overview
23+
24+
Remember your codebase is a product with multiple users. We should treat it as such by providing great experiences for all audiences that interact with it.
25+
26+
```mermaid
27+
graph TD
28+
%% Central Codebase
29+
CODEBASE[🏗️ Codebase<br/>Product]
30+
31+
%% Interface Files
32+
README["📖 README.md<br/><small>User Interface</small>"]
33+
CONTRIBUTING["👥 CONTRIBUTING.md<br/><small>Contributor Interface</small>"]
34+
RUNBOOK["🔧 RUNBOOK.md<br/><small>Operations Interface</small>"]
35+
AGENTS["🤖 AGENTS.md<br/><small>AI Interface</small>"]
36+
BUILD["⚙️ Taskfile<br/><small>Build Interface</small>"]
37+
38+
%% Audience Groups
39+
USERS["👤 Service Users<br/><small>End Users</small>"]
40+
CONTRIBUTORS["🧑‍💻 Contributors<br/><small>Developers</small>"]
41+
OPERATORS["🛠️ Operators<br/><small>DevOps/SRE</small>"]
42+
AI_AGENTS["🤖 AI Agents<br/><small>Copilot/ChatGPT</small>"]
43+
BUILD_AGENTS["🚀 Build Agents<br/><small>CI/CD Systems</small>"]
44+
45+
%% Connections: Interfaces to Codebase
46+
README -.-> CODEBASE
47+
CONTRIBUTING -.-> CODEBASE
48+
RUNBOOK -.-> CODEBASE
49+
AGENTS -.-> CODEBASE
50+
BUILD -.-> CODEBASE
51+
52+
%% Connections: Audiences to Interfaces
53+
USERS ==> README
54+
CONTRIBUTORS ==> CONTRIBUTING
55+
OPERATORS ==> RUNBOOK
56+
AI_AGENTS ==> AGENTS
57+
BUILD_AGENTS ==> BUILD
58+
59+
%% Styling
60+
classDef codebase fill:#4b9ce2,stroke:#333,stroke-width:3px,color:#fff
61+
classDef interface fill:#e3f2fd,stroke:#1976d2,stroke-width:2px,color:#1565c0
62+
classDef audience fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px,color:#4a148c
63+
64+
class CODEBASE codebase
65+
class README,CONTRIBUTING,RUNBOOK,AGENTS,BUILD interface
66+
class USERS,CONTRIBUTORS,OPERATORS,AI_AGENTS,BUILD_AGENTS audience
67+
```
68+
1869
## Support
1970

2071
If your codebase uses codebase interface principles please support the initiative by starring the [Codebase Interface GitHub repository](https://github.com/codebase-interface/codebaseinterface){target="_blank"} and placing the below markdown in the README of your repo.

mkdocs.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,18 @@ plugins:
4545
- search
4646
- git-revision-date-localized:
4747
type: date
48+
- mermaid2
4849

4950
markdown_extensions:
5051
- pymdownx.highlight:
5152
anchor_linenums: true
5253
- pymdownx.inlinehilite
5354
- pymdownx.snippets
54-
- pymdownx.superfences
55+
- pymdownx.superfences:
56+
custom_fences:
57+
- name: mermaid
58+
class: mermaid
59+
format: !!python/name:pymdownx.superfences.fence_code_format
5560
- admonition
5661
- pymdownx.details
5762
- attr_list

0 commit comments

Comments
 (0)