Skip to content

Commit 66ed072

Browse files
committed
feat: add benefits documentation for users and contributors, and update navigation
1 parent ed5b705 commit 66ed072

File tree

3 files changed

+26
-25
lines changed

3 files changed

+26
-25
lines changed

docs/benefits.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Benefits
2+
3+
Benefits can be broken down per codebase audience type as they have been defined up-front. This is a benefit in itself as it allows to be considerate and then specific about the needs of each audience.
4+
5+
## Users
6+
7+
- Users expect to interact with the codebase via a specific entry point that is the README.
8+
- Users get a consistent experience across codebases and have expectations that can either be met or missed.
9+
- Users understanding when expectations are missed promotes feedback and improvement.
10+
- Users should be able to interact with the service based on the good user interface provided by the codebase.
11+
12+
## Contributors
13+
14+
- Contributors expect to interact with the codebase via a specific entry point that is the README.
15+
- Contributors get a consistent experience across codebases and have expectations that can either be met or missed.
16+
- Contributors understanding when expectations are missed promotes feedback and improvement.
17+
- Contributors should be able to make changes to the code base based on the good contributor interface provided by the codebase.
18+
19+
## Operators
20+
21+
## AI Agents
22+
23+
## Build Agents

docs/index.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,3 @@
1010
6. Do not be constrained by current technology and tools - provoke change to how we would like to interact with codebases over current constraints.
1111
7. Utilise cross platform and cross IDE tools and technologies to provide the interfaces.
1212
8. Empathise with your own future self who could become any of the audience perspectives at any time.
13-
14-
## Benefits
15-
16-
Benefits can be broken down per codebase audience type as they have been defined up-front. This is a benefit in itself as it allows to be considerate and then specific about the needs of each audience.
17-
18-
### Users
19-
20-
- Users expect to interact with the codebase via a specific entry point that is the README.
21-
- Users get a consistent experience across codebases and have expectations that can either be met or missed.
22-
- Users understanding when expectations are missed promotes feedback and improvement.
23-
- Users should be able to interact with the service based on the good user interface provided by the codebase.
24-
25-
### Contributors
26-
27-
- Contributors expect to interact with the codebase via a specific entry point that is the README.
28-
- Contributors get a consistent experience across codebases and have expectations that can either be met or missed.
29-
- Contributors understanding when expectations are missed promotes feedback and improvement.
30-
- Contributors should be able to make changes to the code base based on the good contributor interface provided by the codebase.
31-
32-
### Operators
33-
34-
### AI Agents
35-
36-
### Build Agents
37-

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ theme:
1616
- search.share
1717
- content.code.copy
1818
- content.action.edit
19+
- toc.integrate
1920
palette:
2021
- scheme: default
2122
primary: blue
@@ -32,6 +33,8 @@ theme:
3233

3334
nav:
3435
- Home: index.md
36+
- Benefits: benefits.md
37+
3538

3639
plugins:
3740
- search

0 commit comments

Comments
 (0)