From 43dfa619f00fc432b783c427625d1e5629f514e6 Mon Sep 17 00:00:00 2001
From: Sascha Grunert <sgrunert@redhat.com>
Date: Tue, 26 Nov 2024 03:52:38 +0100
Subject: [PATCH] Fix and lint typos (#15)

Signed-off-by: Sascha Grunert <sgrunert@redhat.com>
---
 .github/workflows/lint.yml |  4 ++++
 .typos.toml                | 22 ++++++++++++++++++++++
 README.md                  |  2 +-
 docs/spec.md               |  2 +-
 4 files changed, 28 insertions(+), 2 deletions(-)
 create mode 100644 .typos.toml

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 3da01ab..1952554 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -34,3 +34,7 @@ jobs:
         with:
           config: '.markdownlint.yml'
           args: '**/*.md'
+
+      - uses: crate-ci/typos@b74202f74b4346efdbce7801d187ec57b266bac8 # v1.27.3
+        with:
+          config: .typos.toml
diff --git a/.typos.toml b/.typos.toml
new file mode 100644
index 0000000..1e3d5d3
--- /dev/null
+++ b/.typos.toml
@@ -0,0 +1,22 @@
+[files]
+extend-exclude = [
+    "go.mod",
+    "*.svg"
+]
+ignore-hidden = true
+ignore-files = true
+ignore-dot = true
+ignore-vcs = true
+ignore-global = true
+ignore-parent = true
+
+[default]
+binary = false
+check-filename = true
+check-file = true
+unicode = true
+ignore-hex = true
+identifier-leading-digits = false
+locale = "en"
+extend-ignore-identifiers-re = []
+extend-ignore-re = []
diff --git a/README.md b/README.md
index 4209d0b..f712e35 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ Each of the new ages has brought new technologies and new ways of thinking. The
 
 ## Current Work
 
-The specification, provides a compatible way to package and distribute models based on the current [OCI image specification](https://github.com/opencontainers/image-spec/) and [the artifacts guidelines](https://github.com/opencontainers/image-spec/blob/main/manifest.md#guidelines-for-artifact-usage). For compatibility reasons, it only contains part of the model metadata, and handles model artifacts as opaque binaries. However, it provides a convient way to package AI models in the container image format and can be used as [OCI volume sources](https://github.com/kubernetes/enhancements/issues/4639) in Kubernetes environments.
+The specification, provides a compatible way to package and distribute models based on the current [OCI image specification](https://github.com/opencontainers/image-spec/) and [the artifacts guidelines](https://github.com/opencontainers/image-spec/blob/main/manifest.md#guidelines-for-artifact-usage). For compatibility reasons, it only contains part of the model metadata, and handles model artifacts as opaque binaries. However, it provides a convenient way to package AI models in the container image format and can be used as [OCI volume sources](https://github.com/kubernetes/enhancements/issues/4639) in Kubernetes environments.
 
 For details, please see [the specification](docs/spec.md).
 
diff --git a/docs/spec.md b/docs/spec.md
index f5aeaf7..68e5dab 100644
--- a/docs/spec.md
+++ b/docs/spec.md
@@ -1,6 +1,6 @@
 # Model Format Specification
 
-The specification defines an open standard Artifacial Intelegence model. It is defined through the artifact extension based on [the OCI image specification](https://github.com/opencontainers/image-spec/blob/main/spec.md#image-format-specification), and extends model features through `artifactType` and `annotations`. Model storage and distribution can be optimized based on artifact extension.
+The specification defines an open standard Artifacial Intelligence model. It is defined through the artifact extension based on [the OCI image specification](https://github.com/opencontainers/image-spec/blob/main/spec.md#image-format-specification), and extends model features through `artifactType` and `annotations`. Model storage and distribution can be optimized based on artifact extension.
 
 The goal of this specification is to package models in an OCI artifact to take advantage of OCI distribution and ensure efficient model deployment.