Skip to content

docs: organize features by runtime#537

Open
lancesnider wants to merge 42 commits intomainfrom
organize-by-runtime
Open

docs: organize features by runtime#537
lancesnider wants to merge 42 commits intomainfrom
organize-by-runtime

Conversation

@lancesnider
Copy link
Collaborator

@lancesnider lancesnider commented Mar 11, 2026

This PR updates the structure of the runtime navigation. Instead of having runtimes/feature with all of the runtimes in tabs, we now have a separate page for each feature (runtimes/web/feature).

Live demo: https://rive-organize-by-runtime.mintlify.app/getting-started/introduction

Approvals

  • Web
  • React
  • React Native
  • Flutter
  • Apple
  • Android
  • Unity

Navigation Changes

Main Tab Nav

CleanShot 2026-03-13 at 15 42 40
  1. Merged "Runtimes" and "Game runtimes" into "Implementing Rive". In an upcoming PR this will also include site builders and the Notion integration.
  2. Moved "Feature Support" to "Implementing Rive/Runtime Fundamentals" since it's runtime specific.
  3. Changed "Tutorials" to "Learn". This page is going to get a major revamp soooooon.

Sidebar Name Changes

  1. Renamed all the "Legacy" groups to "Legacy Features" for more clarity.
  2. Renamed "Format" to ".riv File Format" and took it out of "Advanced Features" since it was the only thing in there.
CleanShot 2026-03-13 at 15 44 21

Landing Pages

The top-level fundamentals pages no longer appear in the navigation, but we're keeping them around as landing pages. They're still relevant for cases when we need to link to a runtime feature, but don't know what runtime the user wants to use. For example, when linking from the editor pages.

Here's what each one looks like (you'll need to run this branch locally):

With demos:

CleanShot 2026-03-13 at 15 24 49

Without demos:

CleanShot 2026-03-13 at 15 00 26

For deprecated features:

CleanShot 2026-03-13 at 15 12 20

New Runtime Pages

The new runtime pages are a mix of snippets for shared content and runtime-specific examples.

If I made any content change, no matter how minor, I have included a before/after screenshot to make it easier to review. If a page doesn't include a comment, then the only change is that I got rid of the runtime tabs or the unrelated examples.

Legend

  • ✅ Done
  • ➖ Not applicable
Feature web react rn flutter apple android unity no inbound links redirect
✅ Artboards
✅ Layout
✅ State Machine
✅ Data Binding
✅ Loading Assets
✅ Fonts
✅ Caching
✅ Playing Audio
✅ Logging
✅ Animation Playback
✅ Inputs
✅ Text
✅ Rive Events
✅ Rendering to Bitmap

Runtime-specific Changes

Web

I removed the HTML from any example, keeping them purley JS:

CleanShot 2026-03-11 at 12 31 24

Unreal & Defold

No changes, expect menu location.

Unity

Most of the Unity changes were taking sentences that say "for more info see xyz" and replacing them with content. Sorry Adam, this is gonna be a pain to review! 😂

@lancesnider lancesnider requested a review from a team as a code owner March 11, 2026 19:00
@lancesnider lancesnider marked this pull request as draft March 11, 2026 19:00
---
title: 'Artboards'
description: 'Selecting which artboard to render at runtime'
---
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

@@ -0,0 +1,49 @@
---
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

import ReferencedAssets from "/snippets/runtimes/playing-audio/referenced-assets.mdx"

<Overview />

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

@@ -0,0 +1,64 @@
---
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

@@ -0,0 +1,19 @@
---
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

@@ -0,0 +1,19 @@
---
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

@@ -0,0 +1,19 @@
---
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

@@ -1,8 +1,10 @@
---
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

@@ -1,39 +1,20 @@
---
title: 'Rendering to a Bitmap'
description: 'Render screenshots and video at runtime.'
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

@@ -0,0 +1,32 @@
---
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

@@ -0,0 +1,14 @@
---
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Reorganizes the runtime documentation IA so users navigate by runtime first, with shared content moved into snippets and runtime-specific pages created per feature.

Changes:

  • Replaces “feature pages with runtime tabs” with per-runtime feature pages (e.g. /runtimes/web/<feature>), driven by shared MDX snippets.
  • Adds/updates landing pages (e.g. /runtimes/playing-audio, /runtimes/logging) to route users to runtime-specific guides.
  • Updates many internal links, headings, and deprecation notices to match the new structure.

Reviewed changes

Copilot reviewed 168 out of 170 changed files in this pull request and generated 16 comments.

Show a summary per file
File Description
snippets/runtimes/text/semantics-for-accessibility.mdx Adds shared accessibility guidance for legacy text manipulation.
snippets/runtimes/text/resources.mdx Adds shared “additional resources” section for text docs.
snippets/runtimes/text/overview.mdx Adds shared legacy Text overview + editor reference card.
snippets/runtimes/text/nested-artboard.mdx Adds shared nested text run guidance (legacy).
snippets/runtimes/state-machines/playing-state-machines.mdx Adds shared state machine section header.
snippets/runtimes/state-machines/overview.mdx Adds shared state machine conceptual overview.
snippets/runtimes/state-machines/controlling-playback.mdx Adds shared state machine playback semantics.
snippets/runtimes/rendering-to-bitmap/overview.mdx Adds shared rendering-to-bitmap overview snippet.
snippets/runtimes/playing-audio/web-warning.mdx Adds shared web browser audio restriction warning.
snippets/runtimes/playing-audio/referenced-assets.mdx Adds shared explanation for referenced audio assets.
snippets/runtimes/playing-audio/overview.mdx Adds shared link to editor audio event docs.
snippets/runtimes/playing-audio/embedded-assets.mdx Adds shared explanation for embedded audio assets.
snippets/runtimes/logging/overview.mdx Adds shared logging overview (PII/network note).
snippets/runtimes/loading-assets/resources.mdx Adds shared resources block for loading-assets pages.
snippets/runtimes/loading-assets/overview.mdx Adds shared loading-assets content used across runtimes.
snippets/runtimes/layouts/responsive-layouts.mdx Adds shared responsive layout overview snippet.
snippets/runtimes/layouts/fit-mode.mdx Adds shared Fit-mode explanation and options.
snippets/runtimes/layouts/bounds.mdx Adds shared bounds description for runtimes that support it.
snippets/runtimes/layouts/applying-fit-mode.mdx Adds shared section header for applying fit mode.
snippets/runtimes/layouts/alignment.mdx Adds shared alignment explanation and options.
snippets/runtimes/landing-pages/runtimes.jsx Adds reusable runtime selector card component for landing pages.
snippets/runtimes/inputs/overview.mdx Adds shared deprecation banner + editor link for Inputs.
snippets/runtimes/inputs/nested-inputs.mdx Adds shared nested inputs guidance (legacy).
snippets/runtimes/inputs/controlling-inputs.mdx Adds shared overview of controlling state machine inputs.
snippets/runtimes/fonts/swapping-fonts.mdx Adds shared swapping-fonts intro snippet.
snippets/runtimes/fonts/fallback-fonts.mdx Adds shared fallback-fonts explanation snippet.
snippets/runtimes/fonts/fallback-fonts-unsupported.mdx Adds shared “fallback fonts unsupported” snippet for web-like environments.
snippets/runtimes/events/overview.mdx Adds shared deprecated Events overview snippet.
snippets/runtimes/events/additional-resources.mdx Adds shared events resources snippet.
snippets/runtimes/data-binding/view-models.mdx Adds shared data binding “view models” doc content.
snippets/runtimes/data-binding/view-model-instances.mdx Adds shared “view model instances” doc content.
snippets/runtimes/data-binding/reading-and-writing-properties.mdx Adds shared property access guidance snippet.
snippets/runtimes/data-binding/properties.mdx Adds shared property types table + link to feature support.
snippets/runtimes/data-binding/overview.mdx Adds shared data binding overview link to editor concepts.
snippets/runtimes/data-binding/observability.mdx Adds shared observability explanation snippet.
snippets/runtimes/data-binding/nested-property-paths.mdx Adds shared nested path explanation snippet.
snippets/runtimes/data-binding/lists.mdx Adds shared list properties overview snippet.
snippets/runtimes/data-binding/listing-properties.mdx Adds shared listing/descriptor inspection snippet.
snippets/runtimes/data-binding/images.mdx Adds shared image properties snippet.
snippets/runtimes/data-binding/enums.mdx Adds shared enums snippet.
snippets/runtimes/data-binding/binding.mdx Adds shared binding guidance snippet.
snippets/runtimes/data-binding/auto-binding.mdx Adds shared auto-binding snippet.
snippets/runtimes/data-binding/artboards.mdx Adds shared artboards property snippet.
snippets/runtimes/caching/overview.mdx Adds shared caching overview snippet.
snippets/runtimes/artboards/overview.mdx Adds shared artboards overview link to editor docs.
snippets/runtimes/artboards/choosing-an-artboard.mdx Adds shared artboard selection guidance snippet.
snippets/runtimes/animation-playback/overview.mdx Adds shared deprecated animation playback overview snippet.
snippets/runtimes/animation-playback/controlling-playback.mdx Adds shared controlling playback snippet.
snippets/runtimes/animation-playback/choosing-starting-animations.mdx Adds shared choosing-starting-animations snippet.
snippets/demos.jsx Renames demo titles to match updated IA/labels.
runtimes/web/web-js.mdx Updates web getting started title + fixes caching link to new path.
runtimes/web/state-machines.mdx Adds web-specific state machine playback page (uses shared snippets + examples).
runtimes/web/rive-parameters.mdx Updates loading-assets link to web-specific page.
runtimes/web/rive-events.mdx Adds web Rive Events page (deprecated) with examples and API guidance.
runtimes/web/playing-audio.mdx Adds web audio playback page using shared snippets.
runtimes/web/low-level-api-usage.mdx Updates layout link to web-specific layouts page.
runtimes/web/loading-assets.mdx Adds web loading-assets page with assetLoader usage example.
runtimes/web/layouts.mdx Adds web layouts page using shared snippets + demos and examples.
runtimes/web/inputs.mdx Adds web Inputs page (deprecated) with examples.
runtimes/web/fonts.mdx Adds web fonts page with fallback-fonts unsupported note.
runtimes/web/caching-a-rive-file.mdx Adds web caching guide + demo embed.
runtimes/web/artboards.mdx Adds web artboards selection page.
runtimes/web/animation-playback.mdx Adds web animation playback page (deprecated).
runtimes/runtime-sizes.mdx Sidebar/title cleanup and minor whitespace fix.
runtimes/react/text.mdx Adds React Text page (deprecated) using shared snippets + examples.
runtimes/react/state-machines.mdx Adds React state machine playback page using shared snippets + examples.
runtimes/react/rive-events.mdx Adds React Rive Events page (deprecated) using shared snippets + example.
runtimes/react/rendering-to-a-bitmap.mdx Adds React rendering-to-bitmap page with limitations and alternatives.
runtimes/react/playing-audio.mdx Adds React playing-audio page.
runtimes/react/parameters-and-return-values.mdx Updates Inputs link to React-specific Inputs page.
runtimes/react/loading-assets.mdx Adds React loading-assets page + demos and examples.
runtimes/react/layouts.mdx Adds React layouts page using shared snippets + examples.
runtimes/react/inputs.mdx Adds React Inputs page (deprecated).
runtimes/react/fonts.mdx Adds React fonts page with fallback-fonts unsupported note.
runtimes/react/caching-a-rive-file.mdx Adds React caching guide using useRiveFile.
runtimes/react/artboards.mdx Adds React artboards selection page.
runtimes/react/animation-playback.mdx Adds React animation playback page (deprecated).
runtimes/react-native/text.mdx Adds React Native Text page (deprecated) with New/Legacy runtime tabs.
runtimes/react-native/state-machines.mdx Adds React Native state machine playback page with New/Legacy runtime tabs.
runtimes/react-native/rive-ref-methods.mdx Updates links to React Native-specific data binding/text pages.
runtimes/react-native/rive-events.mdx Adds React Native Rive Events page (deprecated) with New/Legacy runtime tabs.
runtimes/react-native/react-native.mdx Updates several internal links to React Native-specific feature pages.
runtimes/react-native/props.mdx Updates data binding doc link to React Native path.
runtimes/react-native/playing-audio.mdx Adds React Native playing-audio page.
runtimes/react-native/migration-guide.mdx Updates feature links to React Native-specific pages.
runtimes/react-native/fonts.mdx Adds React Native fonts page including fallback fonts usage.
runtimes/react-native/caching-a-rive-file.mdx Adds React Native caching guide with New/Legacy runtime tabs.
runtimes/react-native/artboards.mdx Adds React Native artboards page (includes TODO note).
runtimes/react-native/animation-playback.mdx Adds React Native animation playback page (deprecated) with New/Legacy tabs.
runtimes/playing-audio.mdx Converts top-level page into a runtime selector landing page.
runtimes/logging.mdx Converts top-level page into a runtime selector landing page.
runtimes/flutter/text.mdx Adds Flutter Text page (deprecated) using shared snippets + examples.
runtimes/flutter/state-machines.mdx Adds Flutter state machine playback page using shared snippets + API details.
runtimes/flutter/rive-events.mdx Adds Flutter Rive Events page (deprecated) with listener APIs.
runtimes/flutter/playing-audio.mdx Adds Flutter playing-audio page.
runtimes/flutter/loading-assets.mdx Adds Flutter loading-assets page.
runtimes/flutter/layouts.mdx Adds Flutter layouts page using shared snippets + Flutter-specific APIs.
runtimes/flutter/inputs.mdx Adds Flutter Inputs page (deprecated).
runtimes/flutter/fonts.mdx Adds Flutter fonts page with fallback fonts status notes.
runtimes/flutter/caching-a-rive-file.mdx Adds Flutter caching guide emphasizing file lifecycle/dispose.
runtimes/flutter/caching-a-rave-file.mdx Removes incorrectly named/duplicative caching page.
runtimes/flutter/artboards.mdx Adds Flutter artboards guide for selectors/creation.
runtimes/flutter/animation-playback.mdx Adds Flutter animation playback page (deprecated).
runtimes/apple/text.mdx Adds Apple Text page (deprecated) with legacy API examples.
runtimes/apple/state-machines.mdx Adds Apple state machine playback page with current/legacy runtime tabs.
runtimes/apple/rive-events.mdx Adds Apple Rive Events page (deprecated) with delegate example.
runtimes/apple/playing-audio.mdx Adds Apple playing-audio page + referenced audio + settings/volume.
runtimes/apple/migration-guides.mdx Updates links/whitespace; aligns Text link to Apple path.
runtimes/apple/logging.mdx Adds Apple logging page (current vs legacy runtime).
runtimes/apple/inputs.mdx Adds Apple Inputs page (deprecated).
runtimes/apple/fonts.mdx Adds Apple fonts page including fallback font APIs.
runtimes/apple/caching-a-rive-file.mdx Adds Apple caching guide for current and legacy runtimes.
runtimes/apple/artboards.mdx Adds Apple artboards guide with current vs legacy runtime tabs.
runtimes/apple/apple.mdx Updates Apple overview links (including data binding/artboard references).
runtimes/apple/animation-playback.mdx Adds Apple animation playback page (deprecated).
runtimes/android/text.mdx Adds Android Text page (deprecated) with examples.
runtimes/android/state-machines.mdx Adds Android state machine playback page with Compose vs Legacy tabs.
runtimes/android/rive-events.mdx Adds Android Rive Events page (deprecated) with listener examples.
runtimes/android/rendering-to-a-bitmap.mdx Adds Android rendering-to-bitmap page with Compose/Legacy notes.
runtimes/android/playing-audio.mdx Adds Android playing-audio page.
runtimes/android/migrating-from-legacy.mdx Updates many internal links to runtime-specific pages.
runtimes/android/logging.mdx Adds Android logging page (Compose vs Legacy).
runtimes/android/loading-assets.mdx Adds Android loading-assets page with XML/class-based handler guidance.
runtimes/android/layouts.mdx Adds Android layouts page with Compose vs Legacy APIs.
runtimes/android/inputs.mdx Adds Android Inputs page (deprecated) with nested APIs.
runtimes/android/fonts.mdx Adds Android fonts page including fallback strategy APIs.
runtimes/android/caching-a-rive-file.mdx Adds Android caching guide with reference-count warning.
runtimes/android/artboards.mdx Adds Android artboards guide with Compose vs Legacy APIs.
runtimes/android/animation-playback.mdx Adds Android animation playback page (deprecated).
runtimes/advanced-topic/rendering-to-a-bitmap.mdx Converts advanced topic into runtime-specific navigation cards.
runtimes/advanced-topic/format.mdx Renames “Format” to “.riv File Format” and adds brief intro sentence.
images/icons/unreal-engine-brands-solid.svg Adds Unreal Engine icon asset for runtime selector UI.
game-runtimes/unity/unity.mdx Removes old feature support table (likely replaced by new IA elsewhere).
game-runtimes/unity/tutorials/health-bar.mdx Updates data binding links/formatting to Unity-specific docs.
game-runtimes/unity/text.mdx Updates Unity text docs to use shared snippets + adjusts nested link.
game-runtimes/unity/state-machines.mdx Updates Unity state machine docs to use shared snippets + trims redundant cards.
game-runtimes/unity/rive-events.mdx Updates Unity events docs to use shared deprecated Events overview snippet.
game-runtimes/unity/loading-assets.mdx Removes generic runtime-doc link bullets; keeps Unity-specific constraints note.
game-runtimes/unity/layouts.mdx Reworks Unity layout docs to reuse shared fit/alignment snippets.
game-runtimes/unity/inputs.mdx Adds concrete nested inputs example and API list.
game-runtimes/unity/fundamentals.mdx Updates links/formatting; points animation playback reference to Unity state machines.
game-runtimes/unity/components.mdx Updates Fit docs link to Unity layouts section anchor.
game-runtimes/unity/best-practices.mdx Updates data binding links to Unity-specific docs.
editor/text/text-runs.mdx Updates runtime link away from legacy text-run manipulation docs.
editor/events/overview.mdx Updates “Events at Runtime” section to deprecate runtime events in favor of data binding.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +67 to +76
<NestedArtboard />

## Examples

- [Updating Text at Runtime - Localization example](https://codesandbox.io/p/sandbox/rive-text-react-38lt4k)

#### Reading Text

To read a given text run text value at any given time, reference the `.getTextRunValue()` API on the `rive` instance returned from `useRive`:

Comment on lines +16 to +24
#### Autoplay the State Machine

To auto-play a state machine by default, simply set `autoPlay` to `true`.
```js
export default function Simple() {
const { RiveComponent } = useRive({
src: 'https://cdn.rive.app/animations/vehicles.riv',
stateMachines: "bumpy",
autoplay: true,
Comment on lines +24 to +26
const cards = RUNTIME_DEFS.filter((runtime) => Boolean(runtimes[runtime.key]))
console.log('algo')
if (cards.length === 0) {
Comment on lines +4 to +6
We recommend using [Data Binding](/editor/data-binding/overview) instead as
you'll be able to do a two way text binding.
</Tip>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copy link

Copilot AI commented Mar 16, 2026

@lancesnider I've opened a new pull request, #545, to work on those changes. Once the pull request is ready, I'll request review from you.

I'm going to relocate the links that are anchored to the top of the
sidebar nav.

Early Access was one of the only perks to upgrading, which I'm assuming
is why it was featured so prominently. This PR adds a "Get Rive" page
that includes links to downloads, the web editor, and EA.

<img width="2330" height="1264" alt="CleanShot 2026-03-16 at 13 48
47@2x"
src="https://github.com/user-attachments/assets/582430dd-129b-4e70-98de-af76a864c4e1"
/>
Copy link
Collaborator

@dskuza dskuza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First pass at some comments for the Apple runtime! Some of them may need work on my end. Let me know how I can help!

@tylernij
Copy link
Collaborator

Looks good! Here's what I gleaned from my pass:

  • Instead of Web -> Getting started -> Artboards -> landing page -> Artboards (web), maybe we can just go straight to Artboards (web)
  • For animation playback landing page, there are two deprecation notices, maybe we can remove the latter one
  • In Flutter's font page, there is a notice at the bottom about how fallback fonts are not supported on the WEB but I think that is meant to say flutter

I'm not sure how many of these are intended vs. unintended, though!

@zplata
Copy link
Contributor

zplata commented Mar 18, 2026

We should redirect the preloading-wasm on the React section to the web one:
https://rive-organize-by-runtime.mintlify.app/runtimes/react/preloading-wasm

@lancesnider
Copy link
Collaborator Author

Looks good! Here's what I gleaned from my pass:

  • Instead of Web -> Getting started -> Artboards -> landing page -> Artboards (web), maybe we can just go straight to Artboards (web)
  • For animation playback landing page, there are two deprecation notices, maybe we can remove the latter one
  • In Flutter's font page, there is a notice at the bottom about how fallback fonts are not supported on the WEB but I think that is meant to say flutter

I'm not sure how many of these are intended vs. unintended, though!

  1. Good call. Done. This fixes the same problem on the Flutter runtime page as well.
  2. Updated.
  3. This one was on purpose because you can compile flutter for the web.

@lancesnider
Copy link
Collaborator Author

We should redirect the preloading-wasm on the React section to the web one: https://rive-organize-by-runtime.mintlify.app/runtimes/react/preloading-wasm

Instead I split them out into their own pages. 8933479

Copy link
Collaborator

@dskuza dskuza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reorg looks good! There are a few things I might tweak but they don't have to be part of this PR, plus I already am going to have some merge conflicts with some of my recent work that will need to be merged in after.

Debug.Log($"Available values: {string.Join(", ", enumProperty.EnumValues)}");
enumProperty.Value = enumProperty.EnumValues[0]; // Set to first value
```

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks, Lance!

The only thing to call out is this example section on the Unity Databinding page, which shows Android runtime examples. We can probably remove the section as a whole (until we have more examples) or link to the Unity Getting Started tutorial.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants