Skip to content

Commit e1ecf00

Browse files
committed
docs: add docs
1 parent d3c33da commit e1ecf00

File tree

4 files changed

+19
-6
lines changed

4 files changed

+19
-6
lines changed

website/src/docs/cli/introduction.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ npx rock [command] [options]
1818

1919
The CLI handles all essential build and deployment tasks:
2020

21-
- Building and running APK/APP files on devices and simulators
21+
- Building and running APK/APP/HAP files on devices and simulators
2222
- Creating builds for different variants and configurations
2323
- Generating signed IPA and AAB archives for app stores
2424
- Re-signing archives with fresh JS bundles
@@ -127,6 +127,13 @@ Platform plugins are configured through the [`platform`](/docs/configuration/ind
127127
| `run:ios` | Runs iOS app on simulator or device |
128128
| `sign:ios` | Signs iOS app with certificate and provisioning profile |
129129

130+
- `@rock-js/platform-harmony` – HarmonyOS platform plugin (experimental) with the following commands:
131+
132+
| Command | Description |
133+
| :-------------- | :------------------------------------------ |
134+
| `build:harmony` | Builds HarmonyOS app for emulator or device |
135+
| `run:harmony` | Runs HarmonyOS app on device |
136+
130137
## Command Options
131138

132139
### `rock start` Options
@@ -159,7 +166,7 @@ The `bundle` command creates an optimized JavaScript bundle for your application
159166
| Option | Description |
160167
| :-------------------------------------- | :--------------------------------------------------------------------------------------------------- |
161168
| `--entry-file <path>` | Path to the root JS file, either absolute or relative to JS root |
162-
| `--platform <string>` | Either "ios" or "android" (default: "ios") |
169+
| `--platform <string>` | Either "ios", "android", or "harmony" (default: "ios") |
163170
| `--transformer <string>` | Specify a custom transformer to be used |
164171
| `--dev [boolean]` | If false, warnings are disabled and the bundle is minified (default: true) |
165172
| `--minify [boolean]` | Allows overriding whether bundle is minified. Defaults to false if dev is true, true if dev is false |

website/src/docs/getting-started.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@ To build and run your app on an Android emulator or device, run the `run:android
5656

5757
<PackageManagerTabs command="rock run:android" />
5858

59+
### Running the HarmonyOS app (experimental)
60+
61+
To build and run your app on a HarmonyOS emulator or device, run the `run:harmony` command:
62+
63+
<PackageManagerTabs command="rock run:harmony" />
64+
5965
## Next Steps
6066

6167
- Learn about [CLI commands and features](/docs/cli/introduction)

website/src/docs/introduction.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@ Choose your path: [Getting Started →](/docs/getting-started)
1111
Rock is built for two kinds of teams:
1212

1313
- **Existing React Native teams using Community CLI** who want to improve build times and developer experience while fitting into your existing workflows and infrastructure.
14-
- **iOS/Android native teams** planning to incorporate React Native without disrupting existing workflows: Rock Brownfield lets you add your whole React Native app like any other dependency.
14+
- **iOS/Android/HarmonyOS native teams** planning to incorporate React Native without disrupting existing workflows: Rock Brownfield lets you add your whole React Native app like any other dependency.
1515

1616
:::info New to React Native and building app from scratch?
1717
For **new projects that aren't brownfield**, consider starting with [Expo](https://expo.dev) for the best developer experience and similar remote caching capabilities. We recommend using [this template](https://github.com/nkzw-tech/expo-app-template) for sensible defaults. Rock is designed for teams who have outgrown the Community CLI.
1818
:::
1919

20-
Both types of teams will benefit from Rock's cross‑platform reach: iOS and Android by default, with a flexible architecture that extends to TVs, macOS, Windows, and HarmonyOS (coming soon).
20+
Both types of teams will benefit from Rock's cross‑platform reach: iOS, Android, and experimental HarmonyOS by default, with a flexible architecture that extends to TVs, macOS, and Windows (coming soon).
2121

2222
## Why We Exist
2323

2424
At [Callstack](https://callstack.com/), we work with large teams building complex React Native apps. As maintainers of the Community CLI, we have quite the exposure to how this tool is used in various projects. These teams face similar challenges:
2525

2626
- **Build times** – No reuse of builds across CI jobs and development teams
2727
- **Infrastructure control** – Need to host everything on their own infrastructure
28-
- **Platform diversity** – Shipping to 10+ platforms beyond iOS and Android
28+
- **Platform diversity** – Shipping to 10+ platforms beyond iOS, Android, and HarmonyOS (experimental)
2929
- **Brownfield integration** – Embedding React Native in existing native apps
3030
- **Tech stack complexity** – Adding React Native to mixed technology environments
3131

website/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ features:
2727
details: A plugin‑driven architecture that lets you customize platforms, bundlers, cache providers, and more.
2828
icon: <img src="/add-grid.svg" />
2929
- title: Cross‑platform ready
30-
details: iOS and Android by default; designed to extend to TVs, macOS, and Windows (coming soon).
30+
details: iOS, Android, and experimental HarmonyOS by default; designed to extend to TVs, macOS, and Windows (coming soon).
3131
icon: <img src="/layout-columns.svg" />
3232
- title: Easy Community CLI migration
3333
details: A familiar CLI that helps you develop, run, and build your app. Integrates with Remote Build Cache. Migrate from Community CLI in minutes.

0 commit comments

Comments
 (0)