Skip to content

Commit 5a9a0a4

Browse files
authored
Merge pull request #2110 from Lwiel/new-docs-updated-agents
RDoc-3442 and RDoc-3459
2 parents 48a2f08 + 750d30f commit 5a9a0a4

File tree

165 files changed

+373
-373
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

165 files changed

+373
-373
lines changed

docs/ai-integration/gen-ai-integration/gen-ai-overview.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ and reacts when a document is added or modified by Retrieving the document, Gene
4949
based on its data, Sending these objects to a generative AI model along with instructions regarding what
5050
to do with the data and how to format the reply, and potentially Acting upon the model's response.
5151

52-
<Admonition type="note" title="&lt;a id=the-flow /&gt;The flow" id="lt-a-id-the-flow-gt-the-flow" href="#lt-a-id-the-flow-gt-the-flow">
52+
<Admonition type="note" title="The flow" id="the-flow" href="#the-flow">
5353
Let's put the above stages in order.
5454
<br/>
5555
<br/>
@@ -73,7 +73,7 @@ Let's put the above stages in order.
7373
is applied to handle the results.
7474
</Admonition>
7575

76-
<Admonition type="note" title="&lt;a id=the-elements /&gt;The elements" id="lt-a-id-the-elements-gt-the-elements" href="#lt-a-id-the-elements-gt-the-elements">
76+
<Admonition type="note" title="The elements" id="the-elements" href="#the-elements">
7777
These are the elements that need to be defined for a GenAI task.
7878
<br/>
7979
<br/>
@@ -186,7 +186,7 @@ if($output.Blocked)
186186

187187
</Admonition>
188188

189-
<Admonition type="note" title="&lt;a id=how-to-create-and-run-a-gen-ai-task /&gt;How to create and run a GenAI task" id="lt-a-id-how-to-create-and-run-a-gen-ai-task-gt-how-to-create-and-run-a-genai-task" href="#lt-a-id-how-to-create-and-run-a-gen-ai-task-gt-how-to-create-and-run-a-genai-task">
189+
<Admonition type="note" title="How to create and run a GenAI task" id="how-to-create-and-run-a-genai-task" href="#how-to-create-and-run-a-genai-task">
190190

191191
* You can use [Studio's intuitive wizard](../../ai-integration/gen-ai-integration/gen-ai-studio.mdx#add-a-genai-task)
192192
to create GenAI tasks. The wizard will guide you through the task creation phases,

docs/client-api/commands/documents/delete.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ catch (Exception e)
159159
| Parameter | Type | Description |
160160
|------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
161161
| **id** | `string` | The ID of the document to delete. |
162-
| **changeVector** | `string` | The change-vector of the document you wish to delete,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control-&-change-vectors).<br/>Pass `null` to skip the check and force the deletion. |
162+
| **changeVector** | `string` | The change-vector of the document you wish to delete,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control--change-vectors).<br/>Pass `null` to skip the check and force the deletion. |
163163

164164

165165

@@ -376,7 +376,7 @@ catch (err) \{
376376
| Parameter | Type | Description |
377377
|------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
378378
| **id** | `string` | The ID of the document to delete. |
379-
| **changeVector** | `string` | The change-vector of the document you wish to delete,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control-&-change-vectors).<br/>Pass `null` to skip the check and force the deletion. |
379+
| **changeVector** | `string` | The change-vector of the document you wish to delete,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control--change-vectors).<br/>Pass `null` to skip the check and force the deletion. |
380380

381381

382382

docs/client-api/commands/documents/put.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ var theDocumentCV = putResult.ChangeVector;
193193
| Parameter | Type | Description |
194194
|------------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
195195
| **id** | `string` | Unique ID under which document will be stored. |
196-
| **changeVector** | `string` | The change-vector of the document you wish to update,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control-&-change-vectors).<br/>Pass `null` to skip the check and force the 'put'. |
196+
| **changeVector** | `string` | The change-vector of the document you wish to update,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control--change-vectors).<br/>Pass `null` to skip the check and force the 'put'. |
197197
| **document** | `BlittableJsonReaderObject` | The document to store. Use:<br/>`session.Advanced.JsonConverter.ToBlittable(doc, docInfo);` to convert your entity to a `BlittableJsonReaderObject`. |
198198

199199
<TabItem value="syntax_2" label="syntax_2">
@@ -478,7 +478,7 @@ assert.strictEqual(theDocumentID, "categories/999");
478478
| Parameter | Type | Description |
479479
|------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
480480
| **id** | `string` | Unique ID under which document will be stored. |
481-
| **changeVector** | `string` | The change-vector of the document you wish to update,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control-&-change-vectors).<br/>Pass `null` to skip the check and force the 'put'. |
481+
| **changeVector** | `string` | The change-vector of the document you wish to update,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control--change-vectors).<br/>Pass `null` to skip the check and force the 'put'. |
482482
| **document** | `object` | The document to store. |
483483

484484
<TabItem value="syntax_2" label="syntax_2">

docs/client-api/data-subscriptions/consumption/api-overview.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ export const supportedLanguages = ["csharp", "java", "python", "nodejs"];
2525
* [Create the subscription worker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker)
2626
* [SubscriptionWorkerOptions](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions)
2727
* [Run the subscription worker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker)
28-
* [SubscriptionBatch&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch&lt;t&gt;)
29-
* [SubscriptionBatch&lt;T&gt;.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch&lt;t&gt;item)
30-
* [SubscriptionWorker&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker&lt;t&gt;)
28+
* [SubscriptionBatch&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatcht)
29+
* [SubscriptionBatch&lt;T&gt;.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatchtitem)
30+
* [SubscriptionWorker&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert)
3131

3232
</Admonition>
3333
## Create the subscription worker
@@ -129,7 +129,7 @@ Learn more about `SubscriptionOpeningStrategy` in [worker strategies](../../../c
129129
## Run the subscription worker
130130

131131
After [creating](../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents.
132-
To start processing, you need to call the `Run` method of the [SubscriptionWorker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker&lt;t&gt;).
132+
To start processing, you need to call the `Run` method of the [SubscriptionWorker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert).
133133

134134
The `Run` function takes a delegate, which is your client-side code responsible for processing the received document batches.
135135

@@ -160,7 +160,7 @@ Task Run(Func<SubscriptionBatch<T>, Task> processDocuments,
160160

161161
| Member | Type | Description |
162162
|--------------------------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
163-
| **Items** | `List<SubscriptionBatch<T>.Item>` | List of items in the batch.<br/>See [SubscriptionBatch&lt;T&gt;.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch&lt;t&gt;item) below. |
163+
| **Items** | `List<SubscriptionBatch<T>.Item>` | List of items in the batch.<br/>See [SubscriptionBatch&lt;T&gt;.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatchtitem) below. |
164164
| **NumberOfItemsInBatch** | `int` | Number of items in the batch. |
165165

166166
| Method Signature | Return value | Description |
@@ -285,8 +285,8 @@ Using it outside this scope may cause unexpected behavior.
285285
* [Create the subscription worker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker)
286286
* [SubscriptionWorkerOptions](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions)
287287
* [Run the subscription worker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker)
288-
* [SubscriptionBatch&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch&lt;t&gt;)
289-
* [SubscriptionWorker&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker&lt;t&gt;)
288+
* [SubscriptionBatch&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatcht)
289+
* [SubscriptionWorker&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert)
290290

291291
</Admonition>
292292
## Create the subscription worker
@@ -350,7 +350,7 @@ All other parameters are optional and will default to their respective default v
350350
## Run the subscription worker
351351

352352
After [creating](../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents.
353-
To start processing, you need to call the `run` method of the [SubscriptionWorker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker&lt;t&gt;).
353+
To start processing, you need to call the `run` method of the [SubscriptionWorker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert).
354354

355355
The `run` function takes a delegate, which is your client-side code responsible for processing the received document batches.
356356

docs/client-api/data-subscriptions/creation/examples.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ See how to consume this type of subscription [here](../../../client-api/data-sub
278278
**Include using builder**:
279279

280280
Include statements can be added to the subscription with `ISubscriptionIncludeBuilder`.
281-
This builder is assigned to the `Includes` property in [SubscriptionCreationOptions&lt;T&gt;](../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions&lt;t&gt;).
281+
This builder is assigned to the `Includes` property in [SubscriptionCreationOptions&lt;T&gt;](../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptionst).
282282
It supports methods for including documents as well as [counters](../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters).
283283
These methods can be chained.
284284

@@ -700,7 +700,7 @@ See how to consume this type of subscription [here](../../../client-api/data-sub
700700
**Include using builder**:
701701

702702
Include statements can be added to the subscription with `SubscriptionIncludeBuilder`.
703-
This builder is assigned to the `includes` property in [SubscriptionCreationOptions](../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions&lt;t&gt;).
703+
This builder is assigned to the `includes` property in [SubscriptionCreationOptions](../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptionst).
704704
It supports methods for including documents as well as [counters](../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters).
705705
These methods can be chained.
706706

docs/client-api/faq/transaction-support.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ If you care about avoiding lost updates, you need to ensure you have the conflic
174174

175175
The following is an important aspect to RavenDB's transactional behavior with regards to asynchronous replication.
176176

177-
When replicating modifications to another server, RavenDB will ensure that the [transaction boundaries](../../server/clustering/replication/replication-overview.mdx#replication-&-transaction-boundary) are maintained.
177+
When replicating modifications to another server, RavenDB will ensure that the [transaction boundaries](../../server/clustering/replication/replication-overview.mdx#replication--transaction-boundary) are maintained.
178178
If there are several document modifications in the same transaction they will be sent in the same replication batch, keeping the transaction boundary on the destination as well.
179179

180180
However, a special attention is needed when a document is modified in two separate transactions but the replication of the first transaction has not occurred yet.

docs/client-api/session/updating-entities.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"];
3535

3636

3737
* In this page:
38-
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document-&-update)
39-
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents-&-update)
38+
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document--update)
39+
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents--update)
4040

4141
</Admonition>
4242
## Load a document & update
@@ -158,8 +158,8 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"];
158158

159159

160160
* In this page:
161-
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document-&-update)
162-
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents-&-update)
161+
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document--update)
162+
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents--update)
163163

164164
</Admonition>
165165
## Load a document & update
@@ -236,8 +236,8 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"];
236236

237237

238238
* In this page:
239-
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document-&-update)
240-
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents-&-update)
239+
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document--update)
240+
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents--update)
241241

242242
</Admonition>
243243
## Load a document & update
@@ -323,8 +323,8 @@ try \{
323323

324324

325325
* In this page:
326-
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document-&-update)
327-
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents-&-update)
326+
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document--update)
327+
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents--update)
328328

329329
</Admonition>
330330
## Load a document & update

0 commit comments

Comments
 (0)