Skip to content

Commit 21d14d4

Browse files
committed
docs: improvements
1 parent 37480d8 commit 21d14d4

File tree

9 files changed

+13
-108
lines changed

9 files changed

+13
-108
lines changed

.github/CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ making changes.
1414
- `yarn test:ts`: Run `tsc` type check.
1515
- `yarn test:format`: Run `prettier` check for formatting mistakes.
1616

17+
18+
You can also run unit tests for `shared-storage`, using one of gradle task:
19+
20+
- `./gradlew testAndroidHostTest`
21+
- `./gradlew macosArm64Test`
22+
- `./gradlew iosSimulatorArm64Test`
23+
1724
## Sending a pull request
1825

1926
When you're sending a pull request:

.github/scripts/prepare-mkdocs.sh

Lines changed: 0 additions & 11 deletions
This file was deleted.

.github/workflows/deploy-docs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ jobs:
2626
- name: Prepare MkDocs
2727
run: |
2828
pip install --no-deps -r .github/requirements.txt
29-
.github/scripts/prepare-mkdocs.sh
3029
# required for mike
3130
- name: Setup git user
3231
run: ./setup-ci-git-user.sh

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# React Native Async Storage
22

33
Async Storage is an asynchronous, unencrypted, persistent key-value storage solution for your React Native application.
4-
It provides a simple API compatible with the [Web Storage API]((https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API)), with additional extensions for batch operations and multi-database support.
4+
It provides a simple API compatible with the [Web Storage API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API), with additional extensions for batch operations and multi-database support.
55

66

77
## Supported platforms

docs/api/db-naming.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ createAsyncStorage(`user-${userId}`);
7474

7575
Creates database named `user-1234`:
7676

77-
![web-db-naming-1.png](/assets/db-naming-web-1.png)
77+
![web-db-naming-1.png](../assets/db-naming-web-1.png)
7878

7979
### Windows
8080

docs/changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../packages/async-storage/CHANGELOG.md

docs/contributing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../.github/CONTRIBUTING.md

docs/index.md

Lines changed: 0 additions & 94 deletions
This file was deleted.

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.md

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ site_name: Async Storage
22
repo_url: https://github.com/react-native-async-storage/async-storage
33
site_url: https://react-native-async-storage.github.io/
44

5+
# note: index, contributing and changelog are symlinked
56
nav:
67
- Overview: index.md
78
- API:

0 commit comments

Comments
 (0)