Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit a341611

Browse files
authored
fix(docs); fix broken anchors (#980)
1 parent a0378ea commit a341611

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

docs/docs/core/basics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ An indexing flow, once set up, maintains a long-lived relationship between data
7272
* **One time update**: Once triggered, CocoIndex updates the target data to reflect the version of source data up to the current moment.
7373
* **Live update**: CocoIndex continuously reacts to changes of source data and updates the target data accordingly, based on various **change capture mechanisms** for the source.
7474

75-
See more details in the [build / update target data](flow_methods#build--update-target-data) section.
75+
See more details in the [build / update target data](flow_methods#buildupdate-target-data) section.
7676

7777
3. CocoIndex intelligently reprocesses to propagate source changes to target by:
7878

@@ -101,4 +101,4 @@ As an indexing flow is long-lived, it needs to store intermediate data to keep t
101101
CocoIndex uses internal storage for this purpose.
102102

103103
Currently, CocoIndex uses Postgres database as the internal storage.
104-
See [Settings](settings#databaseconnectionspec) for configuring its location. The internal storage is managed by CocoIndex, see [Setup / drop flow](/docs/core/flow_methods#setup--drop-flow) for more details.
104+
See [Settings](settings#databaseconnectionspec) for configuring its location. The internal storage is managed by CocoIndex, see [Setup / drop flow](/docs/core/flow_methods#setupdrop-flow) for more details.

docs/docs/core/flow_def.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ After it's called, `demo_flow` becomes an invalid object, and you should not cal
5757
:::note
5858

5959
This only removes states of the flow from the current process, and it won't affect the persistent states.
60-
See [Setup / drop flow](/docs/core/flow_methods#setup--drop-flow) if you want to clean up the persistent states.
60+
See [Setup / drop flow](/docs/core/flow_methods#setupdrop-flow) if you want to clean up the persistent states.
6161

6262
:::
6363

@@ -271,7 +271,7 @@ Export must happen at the top level of a flow, i.e. not within any child scopes
271271
* `target_spec`: the target spec as the export target.
272272
* `setup_by_user` (optional):
273273
whether the export target is setup by user.
274-
By default, CocoIndex is managing the target setup (see [Setup / drop flow](/docs/core/flow_methods#setup--drop-flow)), e.g. create related tables/collections/etc. with compatible schema, and update them upon change.
274+
By default, CocoIndex is managing the target setup (see [Setup / drop flow](/docs/core/flow_methods#setupdrop-flow)), e.g. create related tables/collections/etc. with compatible schema, and update them upon change.
275275
If `True`, the export target will be managed by users, and users are responsible for creating the target and updating it upon change.
276276
* Fields to configure [storage indexes](#storage-indexes). `primary_key_fields` is required, and all others are optional.
277277

@@ -293,7 +293,7 @@ def demo_flow(flow_builder: cocoindex.FlowBuilder, data_scope: cocoindex.DataSco
293293
</TabItem>
294294
</Tabs>
295295

296-
The target is managed by CocoIndex, i.e. it'll be created or dropped when [setup / drop flow](/docs/core/flow_methods#setup--drop-flow), and the data will be automatically updated (including stale data removal) when updating the index.
296+
The target is managed by CocoIndex, i.e. it'll be created or dropped when [setup / drop flow](/docs/core/flow_methods#setupdrop-flow), and the data will be automatically updated (including stale data removal) when updating the index.
297297
The `name` for the same target should remain stable across different runs.
298298
If it changes, CocoIndex will treat it as an old target removed and a new one created, and perform setup changes and reindexing accordingly.
299299

@@ -441,7 +441,7 @@ Operation spec is the default way to configure sources, functions and targets. B
441441

442442
* The spec isn't supposed to contain secret information, and it's frequently shown in various places, e.g. `cocoindex show`.
443443
* For targets, once an operation is removed after flow definition code change, the spec is also gone.
444-
But we still need to be able to drop the persistent backend (e.g. a table) when [setup / drop flow](/docs/core/flow_methods#setup--drop-flow).
444+
But we still need to be able to drop the persistent backend (e.g. a table) when [setup / drop flow](/docs/core/flow_methods#setupdrop-flow).
445445

446446
Auth registry is introduced to solve the problems above.
447447

docs/docs/core/flow_methods.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ It creates a `demo_flow` object in `cocoindex.Flow` type.
3434
</TabItem>
3535
</Tabs>
3636

37-
## Setup / drop flow
37+
## Setup/drop flow
3838

3939
For a flow, its persistent backends need to be ready before it can run, including:
4040

0 commit comments

Comments
 (0)