Skip to content

Commit 01d5d56

Browse files
vdusekclaude
andcommitted
docs: Replace relative API reference links with ApiLink component across concept pages
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 52111a2 commit 01d5d56

9 files changed

Lines changed: 50 additions & 47 deletions

docs/02_concepts/02_actor_input.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import ApiLink from '@site/src/components/ApiLink';
1212

1313
The Actor gets its [input](https://docs.apify.com/platform/actors/running/input) from the input record in its default [key-value store](https://docs.apify.com/platform/storage/key-value-store).
1414

15-
To access it, instead of reading the record manually, you can use the [`Actor.get_input`](../../reference/class/Actor#get_input) convenience method. It will get the input record key from the Actor configuration, read the record from the default key-value store,and decrypt any [secret input fields](https://docs.apify.com/platform/actors/development/secret-input).
15+
To access it, instead of reading the record manually, you can use the <ApiLink to="class/Actor#get_input">`Actor.get_input`</ApiLink> convenience method. It will get the input record key from the Actor configuration, read the record from the default key-value store,and decrypt any [secret input fields](https://docs.apify.com/platform/actors/development/secret-input).
1616

1717
For example, if an Actor received a JSON input with two fields, `{ "firstNumber": 1, "secondNumber": 2 }`, this is how you might process it:
1818

@@ -32,6 +32,6 @@ Actors commonly receive a list of URLs to process via their input. The <ApiLink
3232

3333
The Apify platform supports [secret input fields](https://docs.apify.com/platform/actors/development/secret-input) that are encrypted before being stored. When you mark an input field as `"isSecret": true` in your Actor's [input schema](https://docs.apify.com/platform/actors/development/input-schema), the platform encrypts the value with the Actor's public key.
3434

35-
No special handling is needed in your code — when you call [`Actor.get_input`](../../reference/class/Actor#get_input), encrypted fields are automatically decrypted using the Actor's private key, which is provided by the platform via environment variables. You receive the plaintext values directly.
35+
No special handling is needed in your code — when you call <ApiLink to="class/Actor#get_input">`Actor.get_input`</ApiLink>, encrypted fields are automatically decrypted using the Actor's private key, which is provided by the platform via environment variables. You receive the plaintext values directly.
3636

3737
For more details on Actor input and how to define input schemas, see the [Actor input](https://docs.apify.com/platform/actors/running/input) and [input schema](https://docs.apify.com/platform/actors/development/input-schema) documentation on the Apify platform.

docs/02_concepts/03_storages.mdx

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ The `Actor` class provides methods to work either with the default storages of t
2323

2424
There are three types of storages available to Actors.
2525

26-
First are [datasets](https://docs.apify.com/platform/storage/dataset), which are append-only tables for storing the results of your Actors. You can open a dataset through the [`Actor.open_dataset`](../../reference/class/Actor#open_dataset) method, and work with it through the resulting [`Dataset`](../../reference/class/Dataset) class instance.
26+
First are [datasets](https://docs.apify.com/platform/storage/dataset), which are append-only tables for storing the results of your Actors. You can open a dataset through the <ApiLink to="class/Actor#open_dataset">`Actor.open_dataset`</ApiLink> method, and work with it through the resulting <ApiLink to="class/Dataset">`Dataset`</ApiLink> class instance.
2727

28-
Next there are [key-value stores](https://docs.apify.com/platform/storage/key-value-store), which function as a read/write storage for storing file-like objects, typically the Actor state or binary results. You can open a key-value store through the [`Actor.open_key_value_store`](../../reference/class/Actor#open_key_value_store) method, and work with it through the resulting [`KeyValueStore`](../../reference/class/KeyValueStore) class instance.
28+
Next there are [key-value stores](https://docs.apify.com/platform/storage/key-value-store), which function as a read/write storage for storing file-like objects, typically the Actor state or binary results. You can open a key-value store through the <ApiLink to="class/Actor#open_key_value_store">`Actor.open_key_value_store`</ApiLink> method, and work with it through the resulting <ApiLink to="class/KeyValueStore">`KeyValueStore`</ApiLink> class instance.
2929

30-
Finally, there are [request queues](https://docs.apify.com/platform/storage/request-queue). These are queues into which you can put the URLs you want to scrape, and from which the Actor can dequeue them and process them. You can open a request queue through the [`Actor.open_request_queue`](../../reference/class/Actor#open_request_queue) method, and work with it through the resulting [`RequestQueue`](../../reference/class/RequestQueue) class instance.
30+
Finally, there are [request queues](https://docs.apify.com/platform/storage/request-queue). These are queues into which you can put the URLs you want to scrape, and from which the Actor can dequeue them and process them. You can open a request queue through the <ApiLink to="class/Actor#open_request_queue">`Actor.open_request_queue`</ApiLink> method, and work with it through the resulting <ApiLink to="class/RequestQueue">`RequestQueue`</ApiLink> class instance.
3131

3232
Each Actor run has its default dataset, default key-value store and default request queue.
3333

@@ -43,7 +43,7 @@ Each dataset item, key-value store record, or request in a request queue is then
4343

4444
## Local Actor run with remote storage
4545

46-
When developing locally, opening any storage will by default use local storage. To change this behavior and to use remote storage you have to use `force_cloud=True` argument in [`Actor.open_dataset`](../../reference/class/Actor#open_dataset), [`Actor.open_request_queue`](../../reference/class/Actor#open_request_queue) or [`Actor.open_key_value_store`](../../reference/class/Actor#open_key_value_store). Proper use of this argument allows you to work with both local and remote storages.
46+
When developing locally, opening any storage will by default use local storage. To change this behavior and to use remote storage you have to use `force_cloud=True` argument in <ApiLink to="class/Actor#open_dataset">`Actor.open_dataset`</ApiLink>, <ApiLink to="class/Actor#open_request_queue">`Actor.open_request_queue`</ApiLink> or <ApiLink to="class/Actor#open_key_value_store">`Actor.open_key_value_store`</ApiLink>. Proper use of this argument allows you to work with both local and remote storages.
4747

4848
Calling another remote Actor and accessing its default storage is typical use-case for using `force-cloud=True` argument to open remote Actor's storages.
4949

@@ -59,14 +59,14 @@ apify run --purge
5959

6060
There are several methods for directly working with the default key-value store or default dataset of the Actor.
6161

62-
- [`Actor.get_value('my-record')`](../../reference/class/Actor#get_value) reads a record from the default key-value store of the Actor.
63-
- [`Actor.set_value('my-record', 'my-value')`](../../reference/class/Actor#set_value) saves a new value to the record in the default key-value store.
64-
- [`Actor.get_input`](../../reference/class/Actor#get_input) reads the Actor input from the default key-value store of the Actor.
65-
- [`Actor.push_data([{'result': 'Hello, world!'}, ...])`](../../reference/class/Actor#push_data) saves results to the default dataset of the Actor. When using the [pay-per-event pricing model](./pay-per-event), `push_data` returns a `ChargeResult` object that indicates whether the charge limit has been reached. You can also pass a `charged_event_name` parameter to charge for a custom event for each pushed item.
62+
- <ApiLink to="class/Actor#get_value">`Actor.get_value('my-record')`</ApiLink> reads a record from the default key-value store of the Actor.
63+
- <ApiLink to="class/Actor#set_value">`Actor.set_value('my-record', 'my-value')`</ApiLink> saves a new value to the record in the default key-value store.
64+
- <ApiLink to="class/Actor#get_input">`Actor.get_input`</ApiLink> reads the Actor input from the default key-value store of the Actor.
65+
- <ApiLink to="class/Actor#push_data">`Actor.push_data([{'result': 'Hello, world!'}, ...])`</ApiLink> saves results to the default dataset of the Actor. When using the [pay-per-event pricing model](./pay-per-event), `push_data` returns a `ChargeResult` object that indicates whether the charge limit has been reached. You can also pass a `charged_event_name` parameter to charge for a custom event for each pushed item.
6666

6767
## Opening named and unnamed storages
6868

69-
The [`Actor.open_dataset`](../../reference/class/Actor#open_dataset), [`Actor.open_key_value_store`](../../reference/class/Actor#open_key_value_store) and [`Actor.open_request_queue`](../../reference/class/Actor#open_request_queue) methods can be used to open any storage for reading and writing. You can either use them without arguments to open the default storages, or you can pass a storage ID or name to open another storage.
69+
The <ApiLink to="class/Actor#open_dataset">`Actor.open_dataset`</ApiLink>, <ApiLink to="class/Actor#open_key_value_store">`Actor.open_key_value_store`</ApiLink> and <ApiLink to="class/Actor#open_request_queue">`Actor.open_request_queue`</ApiLink> methods can be used to open any storage for reading and writing. You can either use them without arguments to open the default storages, or you can pass a storage ID or name to open another storage.
7070

7171
<RunnableCodeBlock className="language-python" language="python">
7272
{OpeningStoragesExample}
@@ -80,8 +80,8 @@ Besides `id` and `name`, the `open_*` methods also accept an `alias` parameter.
8080

8181
## Deleting storages
8282

83-
To delete a storage, you can use the [`Dataset.drop`](../../reference/class/Dataset#drop),
84-
[`KeyValueStore.drop`](../../reference/class/KeyValueStore#drop) or [`RequestQueue.drop`](../../reference/class/RequestQueue#drop) methods.
83+
To delete a storage, you can use the <ApiLink to="class/Dataset#drop">`Dataset.drop`</ApiLink>,
84+
<ApiLink to="class/KeyValueStore#drop">`KeyValueStore.drop`</ApiLink> or <ApiLink to="class/RequestQueue#drop">`RequestQueue.drop`</ApiLink> methods.
8585

8686
<RunnableCodeBlock className="language-python" language="python">
8787
{DeletingStoragesExample}
@@ -93,11 +93,11 @@ In this section we will show you how to work with [datasets](https://docs.apify.
9393

9494
### Reading & writing items
9595

96-
To write data into a dataset, you can use the [`Dataset.push_data`](../../reference/class/Dataset#push_data) method.
96+
To write data into a dataset, you can use the <ApiLink to="class/Dataset#push_data">`Dataset.push_data`</ApiLink> method.
9797

98-
To read data from a dataset, you can use the [`Dataset.get_data`](../../reference/class/Dataset#get_data) method.
98+
To read data from a dataset, you can use the <ApiLink to="class/Dataset#get_data">`Dataset.get_data`</ApiLink> method.
9999

100-
To get an iterator of the data, you can use the [`Dataset.iterate_items`](../../reference/class/Dataset#iterate_items) method.
100+
To get an iterator of the data, you can use the <ApiLink to="class/Dataset#iterate_items">`Dataset.iterate_items`</ApiLink> method.
101101

102102
<RunnableCodeBlock className="language-python" language="python">
103103
{DatasetReadWriteExample}
@@ -106,8 +106,8 @@ To get an iterator of the data, you can use the [`Dataset.iterate_items`](../../
106106
### Exporting items
107107

108108
You can also export the dataset items into a key-value store, as either a CSV or a JSON record,
109-
using the [`Dataset.export_to_csv`](../../reference/class/Dataset#export_to_csv)
110-
or [`Dataset.export_to_json`](../../reference/class/Dataset#export_to_json) method.
109+
using the <ApiLink to="class/Dataset#export_to_csv">`Dataset.export_to_csv`</ApiLink>
110+
or <ApiLink to="class/Dataset#export_to_json">`Dataset.export_to_json`</ApiLink> method.
111111

112112
<RunnableCodeBlock className="language-python" language="python">
113113
{DatasetExportsExample}
@@ -119,9 +119,9 @@ In this section we will show you how to work with [key-value stores](https://doc
119119

120120
### Reading and writing records
121121

122-
To read records from a key-value store, you can use the [`KeyValueStore.get_value`](../../reference/class/KeyValueStore#get_value) method.
122+
To read records from a key-value store, you can use the <ApiLink to="class/KeyValueStore#get_value">`KeyValueStore.get_value`</ApiLink> method.
123123

124-
To write records into a key-value store, you can use the [`KeyValueStore.set_value`](../../reference/class/KeyValueStore#set_value) method.
124+
To write records into a key-value store, you can use the <ApiLink to="class/KeyValueStore#set_value">`KeyValueStore.set_value`</ApiLink> method.
125125
You can set the content type of a record with the `content_type` argument.
126126
To delete a record, set its value to `None`.
127127

@@ -132,7 +132,7 @@ To delete a record, set its value to `None`.
132132
### Iterating keys
133133

134134
To get an iterator of the key-value store record keys,
135-
you can use the [`KeyValueStore.iterate_keys`](../../reference/class/KeyValueStore#iterate_keys) method.
135+
you can use the <ApiLink to="class/KeyValueStore#iterate_keys">`KeyValueStore.iterate_keys`</ApiLink> method.
136136

137137
<RunnableCodeBlock className="language-python" language="python">
138138
{KvsIteratingExample}
@@ -141,7 +141,7 @@ you can use the [`KeyValueStore.iterate_keys`](../../reference/class/KeyValueSto
141141
### Public URLs of records
142142

143143
To get a publicly accessible URL of a key-value store record,
144-
you can use the [`KeyValueStore.get_public_url`](../../reference/class/KeyValueStore#get_public_url) method.
144+
you can use the <ApiLink to="class/KeyValueStore#get_public_url">`KeyValueStore.get_public_url`</ApiLink> method.
145145

146146
<RunnableCodeBlock className="language-python" language="python">
147147
{KvsPublicRecordExample}
@@ -153,27 +153,27 @@ In this section we will show you how to work with [request queues](https://docs.
153153

154154
### Adding requests to a queue
155155

156-
To add a request into the queue, you can use the [`RequestQueue.add_request`](../../reference/class/RequestQueue#add_request) method.
156+
To add a request into the queue, you can use the <ApiLink to="class/RequestQueue#add_request">`RequestQueue.add_request`</ApiLink> method.
157157

158158
You can use the `forefront` boolean argument to specify whether the request should go to the beginning of the queue, or to the end.
159159

160160
You can use the `unique_key` of the request to uniquely identify a request. If you try to add more requests with the same unique key, only the first one will be added.
161161

162-
Check out the [`Request`](../../reference/class/Request) for more information on how to create requests and what properties they have.
162+
Check out the <ApiLink to="class/Request">`Request`</ApiLink> for more information on how to create requests and what properties they have.
163163

164164
### Reading requests
165165

166-
To fetch the next request from the queue for processing, you can use the [`RequestQueue.fetch_next_request`](../../reference/class/RequestQueue#fetch_next_request) method.
166+
To fetch the next request from the queue for processing, you can use the <ApiLink to="class/RequestQueue#fetch_next_request">`RequestQueue.fetch_next_request`</ApiLink> method.
167167

168-
To get info about a specific request from the queue, you can use the [`RequestQueue.get_request`](../../reference/class/RequestQueue#get_request) method.
168+
To get info about a specific request from the queue, you can use the <ApiLink to="class/RequestQueue#get_request">`RequestQueue.get_request`</ApiLink> method.
169169

170170
### Handling requests
171171

172-
To mark a request as handled, you can use the [`RequestQueue.mark_request_as_handled`](../../reference/class/RequestQueue#mark_request_as_handled) method.
172+
To mark a request as handled, you can use the <ApiLink to="class/RequestQueue#mark_request_as_handled">`RequestQueue.mark_request_as_handled`</ApiLink> method.
173173

174-
To mark a request as not handled, so that it gets retried, you can use the [`RequestQueue.reclaim_request`](../../reference/class/RequestQueue#reclaim_request) method.
174+
To mark a request as not handled, so that it gets retried, you can use the <ApiLink to="class/RequestQueue#reclaim_request">`RequestQueue.reclaim_request`</ApiLink> method.
175175

176-
To check if all the requests in the queue are handled, you can use the [`RequestQueue.is_finished`](../../reference/class/RequestQueue#is_finished) method.
176+
To check if all the requests in the queue are handled, you can use the <ApiLink to="class/RequestQueue#is_finished">`RequestQueue.is_finished`</ApiLink> method.
177177

178178
### Full example
179179

docs/02_concepts/04_actor_events.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ During its runtime, the Actor receives Actor events sent by the Apify platform o
4646
{' '}to another worker server soon.</p>
4747
You can use it to persist the state of the Actor so that once it is executed again on the new server,
4848
it doesn't have to start over from the beginning.
49-
Once you have persisted the state of your Actor, you can call <a href="../../reference/class/Actor#reboot"><code>Actor.reboot</code></a>
49+
Once you have persisted the state of your Actor, you can call <ApiLink to="class/Actor#reboot"><code>Actor.reboot</code></ApiLink>
5050
to reboot the Actor and trigger the migration immediately, to speed up the process.
5151
</td>
5252
</tr>
@@ -84,8 +84,8 @@ During its runtime, the Actor receives Actor events sent by the Apify platform o
8484

8585
## Adding handlers to events
8686

87-
To add handlers to these events, you use the [`Actor.on`](../../reference/class/Actor#on) method,
88-
and to remove them, you use the [`Actor.off`](../../reference/class/Actor#off) method.
87+
To add handlers to these events, you use the <ApiLink to="class/Actor#on">`Actor.on`</ApiLink> method,
88+
and to remove them, you use the <ApiLink to="class/Actor#off">`Actor.off`</ApiLink> method.
8989

9090
<RunnableCodeBlock className="language-python" language="python">
9191
{ActorEventsExample}

docs/02_concepts/05_proxy_management.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ If you want to use Apify Proxy locally, make sure that you run your Actors via t
3636

3737
## Proxy configuration
3838

39-
All your proxy needs are managed by the [`ProxyConfiguration`](../../reference/class/ProxyConfiguration) class. You create an instance using the [`Actor.create_proxy_configuration()`](../../reference/class/Actor#create_proxy_configuration) method. Then you generate proxy URLs using the [`ProxyConfiguration.new_url()`](../../reference/class/ProxyConfiguration#new_url) method.
39+
All your proxy needs are managed by the <ApiLink to="class/ProxyConfiguration">`ProxyConfiguration`</ApiLink> class. You create an instance using the <ApiLink to="class/Actor#create_proxy_configuration">`Actor.create_proxy_configuration()`</ApiLink> method. Then you generate proxy URLs using the <ApiLink to="class/ProxyConfiguration#new_url">`ProxyConfiguration.new_url()`</ApiLink> method.
4040

4141
### Apify proxy vs. your own proxies
4242

0 commit comments

Comments
 (0)