Skip to content

Commit 0ff85da

Browse files
docs: introduction doc updates (#527)
* docs: introduction doc updates * update * Update website/src/docs/getting-started/introduction.md --------- Co-authored-by: Michał Pierzchała <[email protected]>
1 parent b80451d commit 0ff85da

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

website/src/docs/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ It's intentional design decision to explicitly define platforms, bundlers etc, s
4747
// Optional: Additional commands
4848
commands?: Array<Command>;
4949

50-
// Optional: Configure remote cache provider. Currently supports: 'github-actions' or null
51-
remoteCacheProvider?: 'github-actions' | null;
50+
// Optional: Configure remote cache provider. Currently supports: 'github-actions' or custom provider (function).
51+
remoteCacheProvider?: 'github-actions' | () => RemoteBuildCache | null;
5252

5353
fingerprint?: {
5454
// Additional source files/directories to include in fingerprint calculation

website/src/docs/getting-started/introduction.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Introduction
22

3-
Rock is a toolkit designed to accelerate React Native app development for enterprise teams. It provides a CLI and Remote Cache system (currently integrated with GitHub Actions) to make your team's development workflow more efficient.
3+
Rock is a toolkit designed to accelerate React Native app development for enterprise teams. It provides a CLI and Remote Cache system to make your team's development workflow more efficient.
44

55
:::info OK I want to try it!
66
If you feel like skipping this intro section and try it out in existing Community CLI project, head over to [Quick start](/docs/getting-started/index).
@@ -30,14 +30,14 @@ Using anything other than the Community CLI is not an option for them currently.
3030
We build the framework with a clear focus: to serve large teams and complex apps. These projects require flexibility, the ability to host everything on their own, deploy to as many platforms as possible, and decrease onboarding time. That's why our engineering design choices focus on:
3131

3232
- **Modular design**—add your supported platforms and plugins, and integrate existing tools; you can build around our framework
33-
- **Self-hosting**—use your own infrastructure without relying on third-party cloud vendors; whether you're using GitHub Actions or soon Amazon S3 and BitBucket, we got you covered.
33+
- **Self-hosting**—use your own infrastructure without relying on third-party cloud vendors; whether you're using GitHub Actions or Amazon S3 and BitBucket, we got you covered.
3434
- **Incremental adoption**—easily migrate from Community CLI or an existing native app.
3535

3636
## The CLI
3737

3838
We've created a new CLI from scratch with a focus on seamless migration from the Community CLI. Most projects can replace their local build and run experience with our CLI in under 10 minutes.
3939

40-
Its core part is modular configuration mechanism allowing for customizing the capabilities (and soon also DX) to your needs through a system of plugins and replaceable parts of the build chain, such as: bundler, platforms, remote cache provider, or helpers exposed through variety of npm packages.
40+
Its core part is modular configuration mechanism allowing for customizing the capabilities to your needs through a system of plugins and replaceable parts of the build chain, such as: bundler, platforms, remote cache provider, or helpers exposed through variety of npm packages.
4141

4242
:::info Developer Experience
4343
For the best DX we focus on our CLI to be entrypoint to that system. In the future we imagine you can interact with it through other tools, like Shopify's Tophat, AI agent, or a custom CLI you already have and control.
@@ -90,10 +90,9 @@ We've simplified the interface by removing redundant flags:
9090

9191
The Remote Cache is an optional but powerful feature that speeds up your development workflow. It acts as a centralized storage for native app builds that can be retrieved either manually or through our CLI. The cache can be hosted on various platforms:
9292

93-
- GitHub Actions (currently supported)
94-
- Amazon S3 (coming soon)
95-
- Cloudflare R2 (coming soon)
96-
- Your own CI artifacts
93+
- GitHub Actions
94+
- Amazon S3
95+
- Cloudflare R2
9796
- Custom providers
9897

9998
:::note
@@ -105,7 +104,7 @@ Out of the box we support storing artifacts on GitHub Actions and we're working
105104
1. For each build, we calculate a unique hash (fingerprint) with [`@expo/fingerprint`](https://docs.expo.dev/versions/latest/sdk/fingerprint/) that represents your project's native state
106105
2. This hash remains stable across builds unless you:
107106
- Modify native files
108-
- Change native dependencies
107+
- Change dependencies with native code
109108
- Update scripts in package.json
110109
3. When you make JavaScript-only changes, the hash stays the same
111110
4. The CLI checks for matching builds in:
@@ -129,4 +128,4 @@ We provide a set of reusable GitHub Actions that handle:
129128
- Android: keystore (AAB)
130129
- Automatic re-signing of builds with fresh JS bundles on PR updates
131130

132-
Learn more about [GitHub Actions configuration](/docs/remote-cache/github-actions/configuration).
131+
Learn more about [GitHub Actions configuration](/docs/github-actions/configuration).

0 commit comments

Comments
 (0)