docs: align documentation with api reference

Author: msluszniak

docs/docs/06-api-reference/classes/ResourceFetcher.md

@@ -1,6 +1,6 @@
 # Class: ResourceFetcher
 
-Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:63](https://github.com/software-mansion/react-native-executorch/blob/326d6344894d75625c600d5988666e215a32d466/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L63)
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:52](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L52)
 
 This module provides functions to download and work with downloaded files stored in the application's document directory inside the `react-native-executorch/` directory.
 These utilities can help you manage your storage and clean up the downloaded files when they are no longer needed.
@@ -17,67 +17,50 @@ These utilities can help you manage your storage and clean up the downloaded fil
 
 ## Properties
 
-### downloads
+### fs
 
-> `static` **downloads**: `Map`\<[`ResourceSource`](../type-aliases/ResourceSource.md), `DownloadResource`\>
+> `static` **fs**: `object`
 
-Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:64](https://github.com/software-mansion/react-native-executorch/blob/326d6344894d75625c600d5988666e215a32d466/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L64)
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:118](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L118)
 
-## Methods
-
-### cancelFetching()
-
-> `static` **cancelFetching**(...`sources`): `Promise`\<`void`\>
-
-Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:284](https://github.com/software-mansion/react-native-executorch/blob/326d6344894d75625c600d5988666e215a32d466/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L284)
-
-Cancels an ongoing/paused download of files.
-
-#### Parameters
+Filesystem utilities for reading downloaded resources.
 
-##### sources
+#### readAsString()
 
-...[`ResourceSource`](../type-aliases/ResourceSource.md)[]
+> **readAsString**: (`path`) => `Promise`\<`string`\>
 
-The resource identifiers used when calling `fetch()`.
+Reads the contents of a file as a string.
 
-#### Returns
+##### Parameters
 
-`Promise`\<`void`\>
+###### path
 
-A promise that resolves once the download is canceled.
+`string`
 
----
+Absolute file path to read.
 
-### deleteResources()
+##### Returns
 
-> `static` **deleteResources**(...`sources`): `Promise`\<`void`\>
+`Promise`\<`string`\>
 
-Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:327](https://github.com/software-mansion/react-native-executorch/blob/326d6344894d75625c600d5988666e215a32d466/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L327)
+A promise that resolves to the file contents as a string.
 
-Deletes downloaded resources from the local filesystem.
+##### Remarks
 
-#### Parameters
+**REQUIRED**: Used internally for reading configuration files (e.g., tokenizer configs).
 
-##### sources
+#### Remarks
 
-...[`ResourceSource`](../type-aliases/ResourceSource.md)[]
+Provides access to filesystem operations through the configured adapter.
+Currently supports reading file contents as strings for configuration files.
 
-The resource identifiers used when calling `fetch`.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-A promise that resolves once all specified resources have been removed.
-
----
+## Methods
 
 ### fetch()
 
 > `static` **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\>
 
-Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:74](https://github.com/software-mansion/react-native-executorch/blob/326d6344894d75625c600d5988666e215a32d466/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L74)
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:104](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L104)
 
 Fetches resources (remote URLs, local files or embedded assets), downloads or stores them locally for use by React Native ExecuTorch.
 
@@ -100,109 +83,72 @@ Multiple resources that can be strings, asset references, or objects.
 `Promise`\<`string`[] \| `null`\>
 
 If the fetch was successful, it returns a promise which resolves to an array of local file paths for the downloaded/stored resources (without file:// prefix).
-If the fetch was interrupted by `pauseFetching` or `cancelFetching`, it returns a promise which resolves to `null`.
+If the fetch was interrupted, it returns a promise which resolves to `null`.
 
 ---
 
-### getFilesTotalSize()
+### getAdapter()
 
-> `static` **getFilesTotalSize**(...`sources`): `Promise`\<`number`\>
+> `static` **getAdapter**(): [`ResourceFetcherAdapter`](../interfaces/ResourceFetcherAdapter.md)
 
-Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:345](https://github.com/software-mansion/react-native-executorch/blob/326d6344894d75625c600d5988666e215a32d466/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L345)
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:86](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L86)
 
-Fetches the info about files size. Works only for remote files.
-
-#### Parameters
-
-##### sources
-
-...[`ResourceSource`](../type-aliases/ResourceSource.md)[]
-
-The resource identifiers (URLs).
+Gets the current resource fetcher adapter instance.
 
 #### Returns
 
-`Promise`\<`number`\>
-
-A promise that resolves to combined size of files in bytes.
-
----
+[`ResourceFetcherAdapter`](../interfaces/ResourceFetcherAdapter.md)
 
-### listDownloadedFiles()
+The configured ResourceFetcherAdapter instance.
 
-> `static` **listDownloadedFiles**(): `Promise`\<`string`[]\>
+#### Throws
 
-Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:306](https://github.com/software-mansion/react-native-executorch/blob/326d6344894d75625c600d5988666e215a32d466/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L306)
-
-Lists all the downloaded files used by React Native ExecuTorch.
-
-#### Returns
+If no adapter has been set via [setAdapter](#setadapter).
 
-`Promise`\<`string`[]\>
+#### Remarks
 
-A promise, which resolves to an array of URIs for all the downloaded files.
+**INTERNAL**: Used internally by all resource fetching operations.
 
 ---
 
-### listDownloadedModels()
+### resetAdapter()
 
-> `static` **listDownloadedModels**(): `Promise`\<`string`[]\>
+> `static` **resetAdapter**(): `void`
 
-Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:316](https://github.com/software-mansion/react-native-executorch/blob/326d6344894d75625c600d5988666e215a32d466/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L316)
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:73](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L73)
 
-Lists all the downloaded models used by React Native ExecuTorch.
+Resets the resource fetcher adapter to null.
 
 #### Returns
 
-`Promise`\<`string`[]\>
-
-A promise, which resolves to an array of URIs for all the downloaded models.
-
----
-
-### pauseFetching()
-
-> `static` **pauseFetching**(...`sources`): `Promise`\<`void`\>
-
-Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:261](https://github.com/software-mansion/react-native-executorch/blob/326d6344894d75625c600d5988666e215a32d466/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L261)
+`void`
 
-Pauses an ongoing download of files.
+#### Remarks
 
-#### Parameters
-
-##### sources
-
-...[`ResourceSource`](../type-aliases/ResourceSource.md)[]
-
-The resource identifiers used when calling `fetch`.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-A promise that resolves once the download is paused.
+**INTERNAL**: Used primarily for testing purposes to clear the adapter state.
 
 ---
 
-### resumeFetching()
+### setAdapter()
 
-> `static` **resumeFetching**(...`sources`): `Promise`\<`void`\>
+> `static` **setAdapter**(`adapter`): `void`
 
-Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/326d6344894d75625c600d5988666e215a32d466/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273)
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:63](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L63)
 
-Resumes a paused download of files.
+Sets a custom resource fetcher adapter for resource operations.
 
 #### Parameters
 
-##### sources
+##### adapter
 
-...[`ResourceSource`](../type-aliases/ResourceSource.md)[]
+[`ResourceFetcherAdapter`](../interfaces/ResourceFetcherAdapter.md)
 
-The resource identifiers used when calling fetch.
+The adapter instance to use for fetching resources.
 
 #### Returns
 
-`Promise`\<`void`\>
+`void`
+
+#### Remarks
 
-If the fetch was successful, it returns a promise which resolves to an array of local file paths for the downloaded resources (without file:// prefix).
-If the fetch was again interrupted by `pauseFetching` or `cancelFetching`, it returns a promise which resolves to `null`.
+**INTERNAL**: Used by platform-specific init functions (expo/bare) to inject their fetcher implementation.

docs/docs/06-api-reference/enumerations/DownloadStatus.md

@@ -0,0 +1,25 @@
+# Enumeration: DownloadStatus
+
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:23](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L23)
+
+Download status of the file.
+
+## Enumeration Members
+
+### ONGOING
+
+> **ONGOING**: `0`
+
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:27](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L27)
+
+Download is still in progress.
+
+---
+
+### PAUSED
+
+> **PAUSED**: `1`
+
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:32](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L32)
+
+Download is paused.

docs/docs/06-api-reference/enumerations/HTTP_CODE.md

@@ -0,0 +1,25 @@
+# Enumeration: HTTP_CODE
+
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:8](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L8)
+
+Http status codes
+
+## Enumeration Members
+
+### OK
+
+> **OK**: `200`
+
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:11](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L11)
+
+- Everything is ok.
+
+---
+
+### PARTIAL_CONTENT
+
+> **PARTIAL_CONTENT**: `206`
+
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:15](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L15)
+
+- Server has fulfilled a client request for a specific part of a resource, instead of sending the entire file.

docs/docs/06-api-reference/enumerations/SourceType.md

@@ -0,0 +1,55 @@
+# Enumeration: SourceType
+
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:40](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L40)
+
+Types of sources that can be downloaded
+
+## Enumeration Members
+
+### DEV_MODE_FILE
+
+> **DEV_MODE_FILE**: `3`
+
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:59](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L59)
+
+Represents a file served via the metro bundler during development.
+
+---
+
+### LOCAL_FILE
+
+> **LOCAL_FILE**: `1`
+
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:49](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L49)
+
+Represents a file stored locally on the filesystem.
+
+---
+
+### OBJECT
+
+> **OBJECT**: `0`
+
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:44](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L44)
+
+Represents a raw object or data structure.
+
+---
+
+### RELEASE_MODE_FILE
+
+> **RELEASE_MODE_FILE**: `2`
+
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:54](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L54)
+
+Represents a file bundled with the application in release mode.
+
+---
+
+### REMOTE_FILE
+
+> **REMOTE_FILE**: `4`
+
+Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:64](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L64)
+
+Represents a file located at a remote URL.

docs/docs/06-api-reference/functions/cleanupExecutorch.md

@@ -0,0 +1,11 @@
+# Function: cleanupExecutorch()
+
+> **cleanupExecutorch**(): `void`
+
+Defined in: [packages/react-native-executorch/src/index.ts:32](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/index.ts#L32)
+
+Function that cleans current setup of fetching resources.
+
+## Returns
+
+`void`

docs/docs/06-api-reference/functions/initExecutorch.md

@@ -0,0 +1,19 @@
+# Function: initExecutorch()
+
+> **initExecutorch**(`config`): `void`
+
+Defined in: [packages/react-native-executorch/src/index.ts:23](https://github.com/software-mansion/react-native-executorch/blob/9db6e3b8b0f1b11ef66f7c45d29a251b31e9c252/packages/react-native-executorch/src/index.ts#L23)
+
+Function that setups the provided resource fetcher.
+
+## Parameters
+
+### config
+
+[`ExecutorchConfig`](../interfaces/ExecutorchConfig.md)
+
+Configuration that you want to use in resource fetching.
+
+## Returns
+
+`void`