ApiDefinitionGuidelines: Fix spellcheck errors

API and 'extensibilitiy' should be in the dictionary, but yaml -> YAML is reasonable. Signed-off-by: Gabe Goodhart <[email protected]>
instructlab · May 31, 2024 · fc7d51d · fc7d51d
1 parent 70a1546
commit fc7d51d
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/.spellcheck-en-custom.txt b/.spellcheck-en-custom.txt
@@ -3,6 +3,7 @@
 Abhishek
 Akash
 AMDGPU
+API
 arge
 arXiv
 backend
@@ -37,6 +38,7 @@ Eval
 Excalidraw
 exfiltrate
 exfiltrating
+extensibility
 Finetuning
 formedness
 GFX

diff --git a/README.md b/README.md
@@ -46,4 +46,4 @@ easily updated in the future as needed. Some options include:
 
 ### API Specifications
 
-API definitions use [OpenAPI](https://www.openapis.org/) format in [yaml](https://yaml.org/).
+API definitions use [OpenAPI](https://www.openapis.org/) format in [YAML](https://yaml.org/).
diff --git a/docs/api-definitions-guidelines.md b/docs/api-definitions-guidelines.md
@@ -13,7 +13,7 @@ The `InstructLab APIs` are essential for hosting `InstructLab` as a service in a
 
 ## How will service APIs be defined?
 
-Service APIs will be defined using [OpenAPI](https://www.openapis.org/) format in [yaml](https://yaml.org/). For structural and style guidelines, see [api-definitions](../api-definitions/README.md).
+Service APIs will be defined using [OpenAPI](https://www.openapis.org/) format in [YAML](https://yaml.org/). For structural and style guidelines, see [api-definitions](../api-definitions/README.md).
 
 ## Where will service API definitions live?
Original file line number	Diff line number	Diff line change
Expand Up		@@ -46,4 +46,4 @@ easily updated in the future as needed. Some options include:

		### API Specifications

		API definitions use [OpenAPI](https://www.openapis.org/) format in [yaml](https://yaml.org/).
		API definitions use [OpenAPI](https://www.openapis.org/) format in [YAML](https://yaml.org/).