Skip to content

Commit f2d8d5b

Browse files
authored
docs: update readmes (#37)
* docs: update readmes * fix: fix md link * docs: restore local instructions
1 parent 0387c06 commit f2d8d5b

File tree

2 files changed

+21
-12
lines changed

2 files changed

+21
-12
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,17 @@
66
</p>
77

88
Example implementations of the Sanity React SDK.
9+
10+
## Apps
11+
12+
The SDK Examples repo currently houses two apps — the SDK Explorer (`apps/sdk-explorer/`) and the Studio that manages the SDK Explorer's content (`apps/sdk-examples-movies/`).
13+
14+
The SDK Explorer is currently the central point of reference for functional examples built with the Sanity SDK.
15+
16+
### SDK Explorer
17+
18+
👉🏻 **[https://sdk-examples.sanity.dev](https://sdk-examples.sanity.dev)**
19+
20+
The Sanity App SDK Explorer contains an assortment of example interfaces built with our React SDK’s hooks. The purpose of the Explorer is to demonstrate how these hooks can be used to build out interfaces powered by Sanity, with a variety of approaches to styling.
21+
22+
Each example contains an interface rendered in the browser as well as a link to the example’s code on GitHub to demonstrate how the example is built. Example code is enriched with comments and may freely be used in your own applications.

apps/sdk-explorer/README.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,16 @@
11
# SDK Explorer
22

3-
The Sanity App SDK Explorer contains an assortment of example interfaces built with our React SDK’s hooks.
4-
The purpose of the Explorer is to demonstrate how these hooks can be used to build out interfaces powered
5-
by Sanity, with a variety of approaches to styling.
3+
👉🏻 **[https://sdk-examples.sanity.dev](https://sdk-examples.sanity.dev)**
64

7-
Each example contains an interface rendered in the browser as well as a link to the example’s code on
8-
GitHub to demonstrate how the example is built. Example code is enriched with comments and may freely
9-
be used in your own applications.
5+
The Sanity App SDK Explorer contains an assortment of example interfaces built with our React SDK’s hooks. The purpose of the Explorer is to demonstrate how these hooks can be used to build out interfaces powered by Sanity, with a variety of approaches to styling.
106

11-
## Running the SDK Explorer
7+
Each example contains an interface rendered in the browser as well as a link to the example’s code on GitHub to demonstrate how the example is built. Example code is enriched with comments and may freely be used in your own applications.
128

13-
We'll have a deployed version of the SDK Explorer available soon.
14-
15-
For now, you can run the SDK Explorer locally:
9+
Visit the URL above to see the SDK Explorer in action, or follow the steps below to run it locally:
1610

1711
1. Clone the SDK Examples Git repo: `git clone [email protected]:sanity-io/sdk-examples.git`
18-
1. Switch to the SDK Explorer app: `cd ./sdk-examples/sdk-explorer`
19-
1. Install dependencies: `pnpm install`
12+
1. Install the dependencies: `pnpm install`
13+
1. Run the build step: `pnpm build`
14+
1. Switch to the SDK Explorer app: `cd apps/sdk-explorer`
2015
1. Run the application’s dev server: `pnpm dev`
2116
1. Open the URL displayed by the dev server (usually `localhost:5173`)

0 commit comments

Comments
 (0)