Skip to content

Commit aa79bc7

Browse files
authored
docs: update package readmes (#513)
1 parent 59e19a7 commit aa79bc7

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

packages/core/README.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,18 @@
22
<a href="https://sanity.io">
33
<img src="https://cdn.sanity.io/images/3do82whm/next/1dfce9dde7a62ccaa8e8377254a1e919f6c07ad3-128x128.svg" />
44
</a>
5-
<h1 align="center">Sanity Core App SDK</h1>
5+
<h1 align="center">Sanity App SDK (Core)</h1>
66
</p>
77

8-
Core functionality powering the React SDK.
8+
The App SDK Core is a pure TypeScript implementation of the App SDK’s business logic. It powers our React App SDK under the hood, and leaves the door open for future framework specific implementations, too.
99

10-
## Documentation
10+
We highly recommend that users default to using the hooks provided by the React SDK for building custom apps on the Sanity platform, unless you’re looking to create your own Sanity App SDK using this core layer.
1111

12-
- Familiarize yourself with the App SDK via a conceptual overview, a quickstart guide, and a step by step walkthrough on **[the Sanity Docs site](https://sanity.io/docs/app-sdk)**
13-
- Go in depth with the **[App SDK reference docs](https://sdk-docs.sanity.dev)**
14-
- View example implementations on the **[SDK Explorer](https://sdk-examples.sanity.dev)**
12+
**Looking for our React SDK?** You’ll find it on:
13+
14+
- [GitHub](https://github.com/sanity-io/sdk/tree/main/packages/react)
15+
- [Sanity Docs](https://sanity.io/docs/app-sdk)
16+
- [App SDK (React) reference docs](https://reference.sanity.io/_sanity/sdk-react)
1517

1618
## License
1719

packages/react/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
<a href="https://sanity.io">
33
<img src="https://cdn.sanity.io/images/3do82whm/next/1dfce9dde7a62ccaa8e8377254a1e919f6c07ad3-128x128.svg" />
44
</a>
5-
<h1 align="center">Sanity React App SDK</h1>
5+
<h1 align="center">Sanity App SDK (React)</h1>
66
</p>
77

88
React hooks for creating Sanity applications.
99

1010
## Documentation
1111

1212
- Familiarize yourself with the App SDK via a conceptual overview, a quickstart guide, and a step by step walkthrough on **[the Sanity Docs site](https://sanity.io/docs/app-sdk)**
13-
- Go in depth with the **[App SDK reference docs](https://sdk-docs.sanity.dev)**
14-
- View example implementations on the **[SDK Explorer](https://sdk-examples.sanity.dev)**
13+
- Go in depth with the **[App SDK reference docs](https://reference.sanity.io/_sanity/sdk-react)**
14+
- View example implementations on the **[SDK Explorer](https://sdk-explorer.sanity.io)**
1515

1616
## License
1717

0 commit comments

Comments
 (0)