Skip to content

Commit cd69207

Browse files
committed
feat: update documentation structure and add language interface section
1 parent aa691a8 commit cd69207

File tree

7 files changed

+19
-8
lines changed

7 files changed

+19
-8
lines changed

docs/index.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
# Principles
1+
# Home
2+
3+
Welcome to the codebase interface documentation!
4+
5+
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.
6+
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.
8+
9+
## Principles
210

311
1. Identify and empathise with all audience perspectives on the codebase - contributors, users, operators, AI agents, Build agents.
412
2. Provide specific interfaces for each audience perspective.

docs/interfaces/agents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Agents
22

3-
**Primary Audience**: AI Agents
3+
- **Primary Audience**: AI Agents

docs/interfaces/changelog.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Changelog
22

3-
**Primary Audience**: Users
4-
**Secondary Audience**: Contributors, Operators
3+
- **Primary Audience**: Users
4+
- **Secondary Audience**: Contributors, Operators

docs/interfaces/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Contributing
22

3-
**Primary Audience**: Contributors
3+
- **Primary Audience**: Contributors

docs/interfaces/language.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Language
2+
3+
- **Primary Audience**: All Audiences

docs/interfaces/readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Readme
22

3-
**Primary Audience**: Users
4-
**Secondary Audience**: Contributors, Operators
3+
- **Primary Audience**: Users
4+
- **Secondary Audience**: Contributors, Operators

docs/interfaces/runbook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Runbook
22

3-
**Primary Audience**: Operators
3+
- **Primary Audience**: Operators

0 commit comments

Comments
 (0)