rive-app / rive-app/rive-docs

Editor docs contribution backlog

Open
#725 6 comments 1 reaction 1 assignee View on GitHub

@lancesnider is already working on this.

Since Jun 9, 2026.

good first issue
Dominant language
MDX
Stars
30
Forks
56
Avg merge
1d 17h
Merged PRs (30d)
44

Description

This is a public list of documentation tasks that contributors can pick from.

How to use this list

Comment on this issue before starting a task so we can help scope it and avoid duplicate work.

General To Dos βœ…

  • When giving multi-step instructions, the gif should go after the <Steps>.

Undocumented Features

  • Random state machine transitions - #775
  • React imperative method - #786
  • Isolating objects - #788
  • 3d
  • Captions on state machines - #779
  • Default interpolation - #787
  • Scripting optimization and debug settings (inspector when nothing selected)- #793
  • Shaders, including shader targets (inspector when nothing selected) - #793
  • Interface viewport, including managing windows - #794
  • Sidebar reorder/columns - #788
  • Dependency Graph - #790
  • Projects - people confuse projects and workspaces - #802
  • Debug panel - It's no longer just a scripts thing - #796
  • Mesh weighting update - #811
  • Drag to add corner radius or add more points - #834
  • Convert objects to ccomponent #913
  • Editing multiple selected keys at once

Key

Status:
🟒 Done
πŸ”΅ Good enough
🟑 Needs work
🟠 Needs work - medium priority
πŸ”΄ Needs work - high priority

Priority:
πŸ’š Good first issue
πŸ’› Medium difficulty
❀️ Chat with staff before digging into these

Page Notes Status Cost Needs vid Needs demo
getting-started/introduction Use videos or .rivs instead of gifs. I'm not sure that's the perfect representation of a state machine. Maybe use walk, run, jump instead.  πŸ”΅
editor/get-rive   🟒
editor/selection-and-navigation   🟒 x
editor/workflows/dependency-graph   🟒 x x
Interface Overview Does this need re-doing now that we're redone all the child pages? Screenshots? 🟠
editor/interface-overview/overview This feels like it can be significantly condensed. Maybe it can be a single map with a short list of links, rather than giving every area its own section AND its own page. All screenshots are wrong. 🟠
editor/interface-overview/toolbar 🟒
editor/interface-overview/hierarchy 🟒 x
editor/tagging The naming of sections and content focus on the how, but not the why. The reason we care about tagging is that it lets us filter. All screenshots are wrong. Add marketplace example. 🟠 x x
editor/interface-overview/inspector #787 🟒
editor/interface-overview/stage 🟒
editor/keyboard-shortcuts 🟒
editor/fundamentals/design-vs-animate-mode 🟒
Design    
editor/fundamentals/artboards Never talks about how artboards match the size of the parent container at runtime. 🟠 πŸ’š x x
editor/fundamentals/components 🟒 x
Drawing --- ---
editor/fundamentals/shapes-and-paths-overview Could use minor reworking to make it skim-able for people with vector experience. Needs new screenshots. Bad description. Are Enter and Esc shortcuts specific to shapes? If not, we can put it somewhere in interface overview. Or make it a note, rather than a top-level section. Add a marketplace examples 🟑 x
editor/fundamentals/procedural-shapes 🟒
editor/fundamentals/pen-tool-overview It mentions editing procedural shapes, but doesn't document how to do it. Add a marketplace example 🟑 x
editor/fundamentals/fill-and-stroke Too long. Condense or break up. Break feathering into its own doc. Feathering should link to the blog post about why feathering is so damn cool. Bad screenshots. Unexpected hierarchy. Should have a better overview that lets you skip the rest. Add a marketplace examples 🟠 x
editor/fundamentals/edit-vertices Feels like there's som overlap between this page, the overview, and the pen tool page. 🟠 x
editor/manipulating-shapes/trim-path This concept is more simple than what the docs make it seem. Let’s rewrite it. Should this be just a subsection of stroke, rather than its own page? Add a marketplace examples 🟠 x x
editor/manipulating-shapes/clipping Needs a better overview. Outdated gifs. Missing info about new features. Add a marketplace examples 🟑 x
editor/manipulating-shapes/align-and-distribute 🟒 x x
Text --- ---
editor/text/text-overview Overview pages could use conceptual thumbs, like data binding overview has. πŸ”΅
editor/text/text-runs πŸ”΅ x
editor/text/text-styles Variables shouldn't be its own top-level section - it's a property like any other. Maybe call them variable font weight since β€œvariables” can mean something else. Add a marketplace examples 🟑 πŸ’š x
editor/text/text-modifiers Add a marketplace examples 🟑 x
Hierarchical Relationships --- ---
editor/fundamentals/groups Needs a conceptual overview 🟑 x
editor/manipulating-shapes/solos Start with why and a conceptual overview. Frame by frame animation needs a note about limitations - it’s not video. There are now more ways to create solos. Add a marketplace examples 🟠 x
editor/fundamentals/transform-spaces This feels like the core concept of groups and hierarchies, but it's kinda buried. I'm not sure it needs its own page. Add a marketplace examples 🟠 x
editor/fundamentals/freeze-and-origin We talk about how before we talk about why. Feels like it should come earlier in the docs hierarchy. 🟑 βœ…
editor/animate-mode/animating-draw-order Needs quick, conceptual overview. We can mention that it’s animatable, butDraw order doesn’t need to be animated. Add a marketplace examples 🟑 πŸ’š
Responsive Design This concept is really confusing for a lot of users. It feels like the entire section needs rethinking. πŸ”΄
editor/layouts/layouts-overview This doesn't feel like an overview. It goes too far into the weeds. Let's make this more of a conceptual overview with links. Add various example videos showing what layouts can do. Link to layout scripts in 🟠 βœ…
editor/layouts/layout-tools We need to focus on what you can achieve with these tools, rather than jumping straight into the how. 🟠 x x
editor/layouts/layout-parameters     x x
editor/layouts/layout-animation  πŸŸ’  
editor/layouts/n-slicing We need a conceptual overview. Extra credit: A grid of mini videos showing real use cases. Needs conceptual gif. Subcategories need a why. How-to’s should be steps, include gifs. Add a marketplace examples 🟑 x x
Assets  
editor/fundamentals/importing-assets 🟒
editor/text/fonts 🟒 demo font
editor/assets/svg 🟒 demo svg
editor/assets/audio 🟒 demo sound
editor/assets/psd 🟒 demo psd
editor/libraries This one is very confusing to people. Let’s do a full audit. πŸ”΄ x x
Animation  
editor/animate-mode/animate-mode-overview Page needs an audit. Is that example video too old? 🟑
editor/animate-mode/timeline Conceptual overview. Weird hierarchy? Add a marketplace examples 🟑 x
editor/animate-mode/keys Keys and timelines seem like maybe 2 parts of the same thing, rather than needing 2 separate pages? 🟑 x x
editor/animate-mode/interpolation-easing Conceptual overview. Feels like the types can be a single graphic. β€œInterpolation field” feels like it should be β€œCustom easing” or something. Is the Graph Editor a separate concept? If so, give it its own doc. It’d be cool to have a Rive example that actually shows various animations and their curves. 🟠 x
State Machines ---  
editor/state-machine/state-machine The whole thing feels like it could use a rewrite. Add a marketplace example 🟠 x x
editor/state-machine/states β€œStates are simply timeline animations that can play at any point in your state machine.” - not true. This page is important and confusing enough that we should do a full audit. Add a marketplace example 🟠 x
editor/state-machine/transitions 🟒 βœ…
editor/state-machine/layers 🟒 x
editor/state-machine/listeners 🟒 x
Events --- ---
editor/events/overview Listening should be top-level section. Overview should cover listening. Description could be more clear. Add a marketplace example 🟑 x
editor/events/open-url-events Add a marketplace example πŸ”΅ x
editor/events/audio-events Half of this page is about Assets, not specifically audio. This page needs a full audit. Move disclaimer up to the top. Too many people expecting audio to be more feature rich than it is. Add a note that links to scripting audio. Add a marketplace example 🟠 x
Data --- ---
editor/data-binding/overview Add a marketplace example πŸ”΅
editor/data-binding/view-models Add a marketplace example πŸ”΅ x
editor/data-binding/property-types Add a marketplace example πŸ”΅ x
editor/data-binding/binding-data Add a marketplace example πŸ”΅ x
editor/data-binding/controlling-data Add a marketplace example πŸ”΅
Advanced Data Binding --- ---
editor/data-binding/enums Add a marketplace example πŸ”΅ βœ…
editor/data-binding/lists β€œView Model Number with Converter” is how, not why. This is a tough concept - Do a full audit of this page. Add a marketplace example 🟠 x
editor/data-binding/converters Add a marketplace example πŸ”΅ x
editor/data-binding/stateful-components Add a marketplace example πŸ”΅ βœ… x
editor/data-binding/property-groups 🟒 βœ… βœ…
editor/data-binding/migration-guide   🟒 βœ…
Publishing  
editor/exporting/exporting-for-runtime This would be a great place to reiterate that a .riv is production-ready, not a design or prototype. Use steps, rather than paragraphs for how-to’s. 🟒 x
editor/exporting/exporting-for-video-and-static-design Use steps, rather than paragraphs for how-to’s. Double check that there are no new formats. 🟑 πŸ’š x
editor/exporting/exporting-for-backup Move this up in the list. New screenshots. Express that this isn’t the ideal way to share file and link to other methods. 🟑 πŸ’š
editor/embed-urls/overview Maybe call this embedding your Rive file or something. List the limitations of embedded URLs, like how you can’t control a view model from an iframe. 🟒 x
getting-started/best-practices This page needs a lot of work and possibly a rename. πŸ”΄
Workspaces 🟒
account-admin/workspaces/workspaces-overview 🟒
account-admin/workspaces/creating-a-workspace 🟒
account-admin/workspaces/inviting-workspace-members 🟒
account-admin/workspaces/removing-workspace-members 🟒
home/account-admin/workspaces/workspace-status 🟒
editor/manipulating-shapes/manipulating-shapes Is there a more descriptive name for this section? Needs conceptual thumbnails. Add a marketplace example 🟠 πŸ’›
editor/manipulating-shapes/bones 🟒 βœ…
editor/manipulating-shapes/meshes 🟒 βœ…
editor/manipulating-shapes/joysticks Needs conceptual overview. Whole page needs a refreshAdd a marketplace example πŸ”΄ πŸ’› x
Constraints --- ---
editor/constraints/constraints-overview A table of gifs for each type could be cool. Add a marketplace example πŸ”΅ βœ…
editor/constraints/ik-constraint Conceptual overview could be a little better, but it’s very close to great. Add a marketplace example 🟒 needs dead simple example
editor/constraints/distance-constraint 🟒 βœ…
editor/constraints/scale-constraint 🟒 βœ…
editor/constraints/rotation-constraint 🟒 βœ…
editor/constraints/transform-constraint The example looks like it’s showing IK, not transform. 🟑 πŸ’› βœ…
editor/constraints/translation-constraint Add a marketplace example 🟒 βœ…
editor/constraints/follow-path-constraint It’s hard to understand Offset - a gif could help. Add a marketplace example πŸ”΅ πŸ’š x
editor/constraints/scroll-constraint Needs conceptual overview. This whole page could use a deeper audit. 🟑 πŸ’›
editor/fundamentals/revision-history Start with what before jumping right to how. Too many people misunderstanding this as version control and making copies of files and downloading .revs. 🟑 πŸ’š
Accessibility --- ---
editor/accessibility/semantics 🟒 x
account-admin/bring-your-own-bucket 🟒
editor/accessibility/reduced-motion 🟒 βœ…
account-admin/bring-your-own-bucket 🟒
editor/ai-agent/ai-agent Add info about where to top up credits. 🟑
editor/ai-agent/ai-mcp πŸ”΅
Legacy Features --- ---
editor/state-machine/inputs   πŸ”΅
editor/events/general-events   πŸ”΅

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up β€” it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.