Merge branch 'main' of https://github.com/codebase-interface/codebaseinterface

Author: dataGriff

docs/README.md

@@ -8,7 +8,7 @@ By providing specific interfaces for each audience perspective, we can ensure th
 
 ## Support
 
-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 the README of your repo.
+If your codebase uses codebase 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.
 
 ### Badges
 

docs/examples.md

@@ -1,3 +1,3 @@
 # Examples
 
-- [Codebase Interface](https://github.com/codebase-interface/codebaseinterface)
+- [Codebase Interface](https://github.com/codebase-interface/codebaseinterface){target="_blank"}

docs/tooling.md

@@ -1,24 +1,36 @@
 # Tooling
 
+Below is a suite of recommended tooling that can help support the principles of the codebase interface initiative.
+
 ## Abstractions
 
-- [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.
-- [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.
-- [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.
+Abstractions allow you to provide a consistent outer layer for interacting with your codebase without being concerned with localised language or framework variations.
+
+- [Taskfile](https://taskfile.dev/){target="_blank"} - 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.
+- [Makefile](https://www.gnu.org/software/make/){target="_blank"} - 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.
+- [Justfile](https://just.systems/){target="_blank"} - 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.
 
 ## IDE Agnostic Files
 
-- [`.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.
-- [`.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.
+IDE agnostic files allow you to enforce rules or share configuration without IDE vendor lock-in.
+
+- [`.editorconfig`](https://editorconfig.org/){target="_blank"} - 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.
+- [`.env`](https://12factor.net/config){target="_blank"} - 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.
 
 ### Git
 
-- [`.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.
-- [`.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.
-- [`.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.
+Whilst git is not the only source control methodology out there and can be challenged, these files are git-specific and supported across IDEs so are preferred over using vendor specific files.
+
+- [`.gitignore`](https://git-scm.com/docs/gitignore){target="_blank"} - 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.
+- [`.gitattributes`](https://git-scm.com/docs/gitattributes){target="_blank"} - 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.
+- [`.gitmessage`](https://git-scm.com/docs/git-commit#_specifying_the_commit_message){target="_blank"} - 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.
+
+## Pre-Commits
+
+- [`.pre-commit-config.yaml`](https://pre-commit.com/){target="_blank"} - A configuration file for the pre-commit framework, which is a tool for managing and maintaining multi-language pre-commit hooks. 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 YAML files.
 
 ### Docker
 
-- [`.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.
+- [`.dockerignore`](https://docs.docker.com/engine/reference/builder/#dockerignore-file){target="_blank"} - 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.
 
 

mkdocs.yml

@@ -1,8 +1,8 @@
 site_name: Codebase Interface
 site_description: A documented set of principles that aim to promote the ease of use of codebases across languages and frameworks
 site_url: https://codebaseinterface.org
-repo_url: https://github.com/codebaseinterface/codebaseinterface
-repo_name: codebaseinterface/codebaseinterface
+repo_url: https://github.com/codebase-interface/codebaseinterface
+repo_name: codebase-interface/codebaseinterface
 edit_uri: edit/main/docs/
 
 theme: