From c9f159f5d042a7ff2a7ef1a4cc106f2e45935512 Mon Sep 17 00:00:00 2001 From: Gordon Hayes Date: Thu, 29 Aug 2024 15:41:51 +0200 Subject: [PATCH] docs: update links --- README.md | 18 +++++++++++++----- examples/stories/StateMachineDocs.stories.mdx | 2 +- npm/react-canvas-lite/README.md | 2 +- src/components/Rive.tsx | 2 +- 4 files changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index bf2899f..89d4ec2 100644 --- a/README.md +++ b/README.md @@ -27,17 +27,25 @@ This library is a wrapper around the [JS/Wasm runtime](https://github.com/rive-a :house_with_garden: [Homepage](https://rive.app/) -:blue_book: [General help docs](https://help.rive.app/) +:blue_book: [General help docs](https://rive.app/community/doc/) -🛠 [Resources for building in Rive](https://rive.app/resources/) +🛠 [Rive Forums](https://rive.app/community/forums/home) ## Getting started Follow along with the link below for a quick start in getting Rive React integrated into your React apps. -[Getting Started with Rive in React](https://help.rive.app/runtimes/overview/react) +- [Getting Started with Rive in React](https://rive.app/community/doc/react/docRfaSQ0eaE) +- [API documentation](https://rive.app/community/doc/parameters-and-return-values/docJlDMNulDh) -[API documentation](https://help.rive.app/runtimes/overview/react/parameters-and-return-values) +For more information, see the Runtime sections of the Rive help documentation: + +- [Animation Playback](https://rive.app/community/doc/animation-playback/docDKKxsr7ko) +- [Layout](https://rive.app/community/doc/layout/docBl81zd1GB) +- [State Machines](https://rive.app/community/doc/state-machines/docxeznG7iiK) +- [Rive Text](https://rive.app/community/doc/text/docn2E6y1lXo) +- [Rive Events](https://rive.app/community/doc/rive-events/docbOnaeffgr) +- [Loading Assets](https://rive.app/community/doc/loading-assets/doct4wVHGPgC) ## Supported versions @@ -60,7 +68,7 @@ For even more examples and resources on using Rive at runtime or in other tools, Using an older version of the runtime and need to learn how to upgrade to the latest version? Check out the migration guides below in our help center that help guide you through version bumps; breaking changes and all! -[Migration guides](https://help.rive.app/runtimes/overview/react/migrating-from-1.x.x-to-3.x.x) +[Migration guides](https://rive.app/community/doc/migrating-from-v3-to-v4/dociIPXVHKFF) ## Contributing diff --git a/examples/stories/StateMachineDocs.stories.mdx b/examples/stories/StateMachineDocs.stories.mdx index 10e5612..735988b 100644 --- a/examples/stories/StateMachineDocs.stories.mdx +++ b/examples/stories/StateMachineDocs.stories.mdx @@ -16,7 +16,7 @@ import './rive-overview.css'; # State Machine Usage -Not familiar with Rive State Machines? Check out our [help docs](https://help.rive.app/editor/state-machine) on what these are first! +Not familiar with Rive State Machines? Check out our [help docs](https://rive.app/community/doc/state-machine/docwH5zPdh93) on what these are first! The `useStateMachineInput` hook is a helper that makes grabbing references to state machine inputs easier to setup. This hook should be used along with the `useRive` hook, as you need to pass in the `rive` instance returned from `useRive`. See each of the examples below to see usage of the hook creating instance of three types of inputs: diff --git a/npm/react-canvas-lite/README.md b/npm/react-canvas-lite/README.md index 75e3252..c638c2a 100644 --- a/npm/react-canvas-lite/README.md +++ b/npm/react-canvas-lite/README.md @@ -6,4 +6,4 @@ Output for `rive-react` using the backing `@rive-app/canvas-lite` JS runtime. The current `@rive-app/react-canvas` dependency supports all Rive features and contains the necessary backing dependencies to render those graphics. This `lite` version has the same API, but does not compile and build with certain dependencies in order to keep the package size as small as possible. -At this time, this lite version of `@rive-app/react-canvas-lite` will not render [Rive Text](https://help.rive.app/editor/text) onto the canvas. Note however, that even if your Rive file may include Rive Text components when using this package, the canvas will still render the graphic without the Rive Text components. +At this time, this lite version of `@rive-app/react-canvas-lite` will not render Rive Text onto the canvas or play Rive Audio. Note however, that even if your Rive file may include Rive Text components, rendering the graphic should not cause any app errors, or cease to render. The same is true for playing audio. diff --git a/src/components/Rive.tsx b/src/components/Rive.tsx index 3211ad4..567953c 100644 --- a/src/components/Rive.tsx +++ b/src/components/Rive.tsx @@ -21,7 +21,7 @@ export interface RiveProps { */ stateMachines?: string | string[]; /** - * Specify a starting Layout object to set Fill and Alignment for the drawing surface. See docs at https://help.rive.app/runtimes/layout for more on layout configuration. + * Specify a starting Layout object to set Fill and Alignment for the drawing surface. See docs at https://rive.app/community/doc/layout/docBl81zd1GB for more on layout configuration. */ layout?: Layout; /**