Skip to content

Commit 9bae9f2

Browse files
committed
feat: restructure documentation navigation and add tooling section
1 parent 66ed072 commit 9bae9f2

File tree

3 files changed

+16
-4
lines changed

3 files changed

+16
-4
lines changed

docs/index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# Codebase Interface
2-
3-
## Principles
1+
# Principles
42

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

docs/tooling.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Tooling
2+
3+
## Abstractions
4+
5+
- [Taskfile](https://taskfile.dev/) - A simple and easy to use task runner / build tool that aims to be a simpler and more powerful Make alternative. It is written in Go and uses a YAML file to define tasks. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be run from the command line.
6+
7+
## IDE Agnostic Files
8+
9+
- [EditorConfig](https://editorconfig.org/) - A file format and collection of text editor plugins for maintaining consistent coding styles between different editors and IDEs. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports the EditorConfig file format.
10+
- [`.gitignore`](https://git-scm.com/docs/gitignore) - A plain text file that tells Git which files and directories to ignore in a project. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports Git.
11+
- [`.gitattributes`](https://git-scm.com/docs/gitattributes) - A plain text file that tells Git how to handle certain files in a project. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports Git.
12+
- [`.dockerignore`](https://docs.docker.com/engine/reference/builder/#dockerignore-file) - A plain text file that tells Docker which files and directories to ignore when building an image. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports Docker.
13+
- [`.env`](https://12factor.net/config) - A plain text file that contains environment variables for a project. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports environment variables.

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,9 @@ theme:
3232
name: Switch to light mode
3333

3434
nav:
35-
- Home: index.md
35+
- Principles: index.md
3636
- Benefits: benefits.md
37+
- Tooling: tooling.md
3738

3839

3940
plugins:

0 commit comments

Comments
 (0)