From fc7d51d6d71d5ce5e3a737f58615c41a62ac5c3c Mon Sep 17 00:00:00 2001 From: Gabe Goodhart Date: Fri, 31 May 2024 15:12:22 -0600 Subject: [PATCH] ApiDefinitionGuidelines: Fix spellcheck errors API and 'extensibilitiy' should be in the dictionary, but yaml -> YAML is reasonable. Signed-off-by: Gabe Goodhart --- .spellcheck-en-custom.txt | 2 ++ README.md | 2 +- docs/api-definitions-guidelines.md | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.spellcheck-en-custom.txt b/.spellcheck-en-custom.txt index 22db77fb..4ec0d500 100644 --- 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 index b03af186..f998a2a1 100644 --- 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 index af8ecf7c..0dae2825 100644 --- 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?