Skip to content

Commit f9eca30

Browse files
committed
feat: update tooling documentation and add new user and interface sections
1 parent 8725f43 commit f9eca30

File tree

5 files changed

+21
-6
lines changed

5 files changed

+21
-6
lines changed

.vscode/settings.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
"cSpell.words": [
33
"codebaseinterface",
44
"fontawesome",
5+
"gitmessage",
56
"inlinehilite",
7+
"Justfile",
68
"linenums",
79
"livereload",
810
"mkdocs",

docs/audiences/users.md

Whitespace-only changes.

docs/interfaces.md

Whitespace-only changes.

docs/tooling.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,22 @@
33
## Abstractions
44

55
- [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+
- [Makefile](https://www.gnu.org/software/make/) - A build automation tool that automatically builds executable programs and libraries from source code by reading files called Makefiles which specify how to derive the target program. 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.
7+
- [Justfile](https://just.systems/) - A command runner that allows you to define and run commands in a simple and easy to use way. It is written in Rust and uses a simple syntax to define commands. 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.
68

79
## IDE Agnostic Files
810

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.
11+
- [`.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.
12+
- [`.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.
13+
14+
### Git
15+
1016
- [`.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.
1117
- [`.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.
18+
- [`.gitmessage`](https://git-scm.com/docs/git-commit#_specifying_the_commit_message) - A plain text file that contains a template for commit messages. 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.
19+
20+
### Docker
21+
1222
- [`.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.
23+
24+

mkdocs.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,12 @@ 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
34+
# nav:
35+
# - Principles: index.md
36+
# - Benefits: benefits.md
37+
# - Tooling: tooling.md
38+
# - Audiences: audiences
39+
# - Users: audiences/users.md
3840

3941

4042
plugins:

0 commit comments

Comments
 (0)