UGemini v2.3.0-preview.2

- Fixed documentation.
Uralstech · Oct 4, 2024 · 18e76b6 · 18e76b6
1 parent 3dd4417
commit 18e76b6
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 77 deletions.
diff --git a/Documentation/DocSource/BreakingChanges.md b/Documentation/DocSource/BreakingChanges.md
diff --git a/Documentation/DocSource/QuickStart.md b/Documentation/DocSource/QuickStart.md
@@ -2,6 +2,10 @@
 
 Please note that the code provided in this page is *purely* for learning purposes and is far from perfect. Remember to null-check all responses!
 
+## Breaking Changes Notice
+
+If you've just updated UGemini, it is recommended to check out the [*releases page*](https://github.com/Uralstech/UGemini/releases) for information on breaking changes for each update.
+
 ## Setup
 
 Add an instance of `Uralstech.UGemini.GeminiManager` to your scene, and set it up with your Gemini API key. You can get your API key from [*here*](https://makersuite.google.com/app/apikey).

diff --git a/Documentation/DocSource/toc.yml b/Documentation/DocSource/toc.yml
@@ -9,6 +9,4 @@ items:
 - name: GeminiChatRequest Features
   href: GeminiChatRequestFeatures.md
 - name: All Endpoints
-  href: AllEndpoints.md
-- name: UGemini v2 Breaking Changes
-  href: BreakingChanges.md
+  href: AllEndpoints.md
diff --git a/UGemini/Packages/com.uralstech.ugemini/Documentation~/APIReferenceManual.pdf b/UGemini/Packages/com.uralstech.ugemini/Documentation~/APIReferenceManual.pdf
diff --git a/UGemini/Packages/com.uralstech.ugemini/Documentation~/Documentation.pdf b/UGemini/Packages/com.uralstech.ugemini/Documentation~/Documentation.pdf
diff --git a/...s/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Documents/GeminiCorporaDocumentId.cs b/...s/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Documents/GeminiCorporaDocumentId.cs
@@ -34,7 +34,7 @@ public GeminiCorpusDocumentId(string documentName)
         /// Creates a new <see cref="GeminiCorpusDocumentId"/>.
         /// </summary>
         /// <param name="corpusId">The resource ID of the Corpus which contains the Document.</param>
-        /// <param name="documentNameOrId">The name (format 'corpora/{corpusId}/documents/{documentId}') or ID of the Document.</param
+        /// <param name="documentNameOrId">The name (format 'corpora/{corpusId}/documents/{documentId}') or ID of the Document.</param>
         public GeminiCorpusDocumentId(GeminiCorpusId corpusId, string documentNameOrId)
         {
             CorpusId = corpusId.ResourceId;

diff --git a/...ges/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Patch/GeminiCorporaPatchRequest.cs b/...ges/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Patch/GeminiCorporaPatchRequest.cs
@@ -47,7 +47,7 @@ public string GetEndpointUri(GeminiRequestMetadata metadata)
         }
 
         /// <summary>
-        /// Creates a new <see cref="GeminiCorporaPatchRequest"/>.
+        /// Creates a new <see cref="GeminiCorporaPatchRequest{TPatchData}"/>.
         /// </summary>
         /// <remarks>
         /// Only available in the beta API.

diff --git a/...es/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Query/GeminiCorporaQueryResponse.cs b/...es/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Query/GeminiCorporaQueryResponse.cs
@@ -5,7 +5,7 @@
 namespace Uralstech.UGemini.CorporaAPI
 {
     /// <summary>
-    /// The response for a <see cref="GeminiCorporaQueryRequest"/> or <see cref="Documents.GeminiCorporaDocumentQueryRequest"/> call.
+    /// The response for a <see cref="GeminiCorporaQueryRequest"/> call.
     /// </summary>
     [JsonObject(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
     public class GeminiCorporaQueryResponse

diff --git a/UGemini/Packages/com.uralstech.ugemini/package.json b/UGemini/Packages/com.uralstech.ugemini/package.json
@@ -9,7 +9,7 @@
     "AI",
     "Integration"
   ],
-  "version": "2.3.0-preview.1",
+  "version": "2.3.0-preview.2",
   "unity": "2022.3",
   "hideInEditor": false,
   "documentationUrl": "https://uralstech.github.io/UGemini/",