Skip to content

Commit c92623f

Browse files
committed
docs: restructure documentation by consolidating audience and interface sections, removing outdated files, and enhancing navigation
1 parent 6df181e commit c92623f

19 files changed

+82
-40
lines changed

docs/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ 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+
## Guide
10+
11+
- [Principles](./principles.md)
12+
- [Audiences](./audiences.md)
13+
- [Interfaces](./interfaces.md)
14+
- [Benefits](./benefits.md)
15+
- [Examples](./examples.md)
16+
- [Tooling](./tooling.md)
17+
918
## Support
1019

1120
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.

docs/audiences.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Audiences
2+
3+
## Users
4+
5+
## Contributors
6+
7+
## Operators
8+
9+
## AI Agents
10+
11+
## Build Agents
12+
13+
## What's Next?
14+
15+
Now that you understand the audiences its time to explore the interfaces designed for each audience.
16+
17+
[← Previous: Principles](../){ .md-button }
18+
[Next: Interfaces →](../interfaces/){ .md-button .md-button--primary style="float: right;" }

docs/audiences/ai_agents.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/audiences/build_agents.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/audiences/contributors.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/audiences/operators.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/audiences/users.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/benefits.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,7 @@ Benefits can be broken down per codebase audience type as they have been defined
2020

2121
## AI Agents
2222

23-
## Build Agents
23+
## Build Agents
24+
25+
[← Previous: Interfaces](../){ .md-button }
26+
[Next: Tooling →](../tooling/){ .md-button .md-button--primary style="float: right;" }

docs/examples.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,6 @@
3636
## Source Aligned Services
3737

3838
TODO: Add examples of source aligned services that follow the codebase interface principles.
39+
40+
[← Previous: Tooling](../){ .md-button }
41+
[Next: Welcome →](../){ .md-button .md-button--primary style="float: right;" }

docs/interfaces.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Interfaces
2+
3+
## Readme
4+
5+
- **Primary Audience**: Users
6+
- **Secondary Audience**: Contributors, Operators
7+
8+
## Contributing
9+
10+
- **Primary Audience**: Contributors
11+
12+
## Runbook
13+
14+
- **Primary Audience**: Operators
15+
16+
## Changelog
17+
18+
- **Primary Audience**: Users
19+
- **Secondary Audience**: Contributors, Operators
20+
21+
## Language
22+
23+
- **Primary Audience**: All Audiences
24+
25+
## Agents
26+
27+
- **Primary Audience**: AI Agents
28+
29+
## What's Next?
30+
31+
Now that you understand the interfaces, its time to explore the benefits of adopting the Codebase Interface principles.
32+
33+
[← Previous: Audiences](../){ .md-button }
34+
[Next: Benefits →](../benefits/){ .md-button .md-button--primary style="float: right;" }

0 commit comments

Comments
 (0)