Skip to content

Commit f690753

Browse files
committed
feat: enhance documentation structure with principles, examples, and audience sections
1 parent 2f2ca1b commit f690753

File tree

4 files changed

+57
-16
lines changed

4 files changed

+57
-16
lines changed

docs/examples.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Examples
2+
3+
- [Codebase Interface](https://github.com/codebase-interface/codebaseinterface)

docs/index.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,28 @@ The codebase interface is a set of principles and practices that allow us to ide
66

77
By providing specific interfaces for each audience perspective, we can ensure that everyone has a clean and maintainable experience when interacting with a codebase.
88

9-
## Principles
10-
11-
1. Identify and empathise with all audience perspectives on the codebase - contributors, users, operators, AI agents, Build agents.
12-
2. Provide specific interfaces for each audience perspective.
13-
3. Ensure each audience interface is clean and remains maintainable.
14-
4. Provide a consistent abstraction over languages and frameworks.
15-
5. Provide a codebase experience that can be replicated by any audience, anywhere and on any platform.
16-
6. Do not be constrained by current technology and tools - provoke change to how we would like to interact with codebases over current constraints.
17-
7. Utilise cross platform and cross IDE tools and technologies to provide the interfaces.
18-
8. Empathise with your own future self who could become any of the audience perspectives at any time.
9+
## Support
10+
11+
If your codebase uses codebase principles please support the initiative by starring the [Codebase Interface GitHub repository](github.com/codebase-interface/codebaseinterface) and placing the below markdown in your repo.
12+
13+
### Badges
14+
15+
#### Primary
16+
17+
```md
18+
[![Codebase Interface Principles](https://img.shields.io/badge/Codebase%20Interface-Principles-4b9ce2?style=flat-square&logo=semanticweb&logoColor=white)](https://codebaseinterface.org)
19+
20+
> This repository follows the **Codebase Interface Principles** — for a better experience for everyone who works with it.
21+
```
22+
23+
#### Simple
24+
25+
```md
26+
[![Codebase Interface](https://img.shields.io/badge/Codebase_Interface-Principles-blue?style=flat)](https://codebaseinterface.org)
27+
```
28+
29+
#### Footer
30+
31+
```md
32+
_Follows the [Codebase Interface Principles](https://codebaseinterface.org)._
33+
```

docs/principles.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Principles
2+
3+
1. Identify and empathise with all audience perspectives on the codebase - contributors, users, operators, AI agents, Build agents.
4+
2. Provide specific interfaces for each audience perspective.
5+
3. Ensure each audience interface is clean and remains maintainable.
6+
4. Provide a consistent abstraction over languages and frameworks.
7+
5. Provide a codebase experience that can be replicated by any audience, anywhere and on any platform.
8+
6. Do not be constrained by current technology and tools - provoke change to how we would like to interact with codebases over current constraints.
9+
7. Utilise cross platform and cross IDE tools and technologies to provide the interfaces.
10+
8. Empathise with your own future self who could become any of the audience perspectives at any time.

mkdocs.yml

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,25 @@ theme:
3131
icon: material/brightness-4
3232
name: Switch to light mode
3333

34-
# nav:
35-
# - Principles: index.md
36-
# - Benefits: benefits.md
37-
# - Tooling: tooling.md
38-
# - Audiences: audiences
39-
# - Users: audiences/users.md
34+
nav:
35+
- Welcome: index.md
36+
- Principles: principles.md
37+
- Audiences:
38+
- audiences/contributors.md
39+
- audiences/users.md
40+
- audiences/operators.md
41+
- audiences/ai_agents.md
42+
- audiences/build_agents.md
43+
- Interfaces:
44+
- interfaces/readme.md
45+
- interfaces/contributing.md
46+
- interfaces/runbook.md
47+
- interfaces/agents.md
48+
- interfaces/changelog.md
49+
- interfaces/language.md
50+
- Benefits: benefits.md
51+
- Tooling: tooling.md
52+
- Examples: examples.md
4053

4154

4255
plugins:

0 commit comments

Comments
 (0)