Skip to content

Editor docs contribution backlog #725

@lancesnider

Description

@lancesnider

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

  • Missing docs for Projects 🔴 - People usually want Projects when they reach for Workspaces.
  • When giving multi-step instructions, the gif should go after the <Steps>.

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
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   🔵  
Interface Overview This entire section is way out of date. Screenshots are wrong. Starting the page with 2 vids in a row is weird. Maybe file browser needs to be its own page? 🔴  
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 Do we need to go into every menu item here? That's going to make this constantly obsolete. Also, we'll have duplicate content when we explain the feature elsewhere. Can we get away with making this more general? 🟠  
editor/interface-overview/hierarchy This gets into a lot of content that's explained elsewhere. Why are we also talking about the data and assets panels here when those have a dedicated page? At most lets have 1 sentence for each, then a link to the relevant feature. All screenshots are wrong. 🟠  
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. 🟠  
editor/interface-overview/inspector WAY out of date. Tries to explain every possible inspector panel, which is no longer possible. Let’s just say the types of things we expect to see here. At most, we can mention features and link to more content. Out-of-date screenshots. 🔴  
editor/interface-overview/stage Has missing youtube video. Does it need to be removed or replaced? Should probably be the first interface overview. Some weird overlap between stage and toolbar tools. 🔴 💛
editor/keyboard-shortcuts Could use a better overview. Right now it's specific to navigation, but shortcuts do much more than that. 🟡 💚
editor/fundamentals/design-vs-animate-mode It never talks about why we have 2 modes. This is a common point of frustration so we need to be more clear. It feels longer than it needs to be and can probably be condensed. 🟡  
Design    
editor/fundamentals/artboards Bad subheading. Needs a conceptual overview. How do we feel about the order of the sections?Never talks about how artboards match the size of the parent container at runtime. Is the Link Icon section necessary? Lots of concepts that aren't specific to Artboards. Old screenshots. Add a marketplace example to Selected Colors 🔴 ❤️
editor/fundamentals/components Need more tie-in with artboards. Maybe these should be a single doc?Needs a conceptual overview. Overlap with responsive layouts? Bad screenshots. Add a marketplace examples 🔴  
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 🟡  
editor/fundamentals/procedural-shapes "procedural shapes" vs "shapes tool". Needs overview. Needs new screenshots. Is “origin” section shape specific? If not, move it or make it a Note. Bad screenshots. Weird hierarchy. Add a marketplace example? 🟡  
editor/fundamentals/pen-tool-overview It mentions editing procedural shapes, but doesn't document how to do it. Add a marketplace example 🟡  
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 🟠  
editor/fundamentals/edit-vertices Feels like there's som overlap between this page, the overview, and the pen tool page. 🟠  
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 🟠  
editor/manipulating-shapes/clipping Needs a better overview. Outdated gifs. Missing info about new features. Add a marketplace examples 🟡  
Text --- ---  
editor/text/text-overview Overview pages could use conceptual thumbs, like data binding overview has. 🔵  
editor/text/text-runs Needs to explain why we have text runs and how they’re children of text elements. Add a marketplace examples 🟡 💚
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 🟡 💚
editor/text/text-modifiers Add a marketplace examples 🟡  
editor/text/fonts The overview could use some workA lot of this content feels like it should go under Assets, not fontsAdd a marketplace examples 🟠  
Hierarchical Relationships --- ---  
editor/fundamentals/groups Needs a conceptual overview 🟡  
editor/fundamentals/selecting-and-navigating-groups Feels like it should be part of groups, rather than having its own page. Or general navigation. Add a marketplace example 🟠  
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 🟠  
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 🟠  
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. 🟠  
editor/layouts/layout-parameters      
editor/layouts/layout-styles      
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 🟡  
editor/layouts/scrolling Needs conceptual overview. This whole page could use a deeper audit. Should this live in constraints? Add a marketplace examples 🟠  
Assets Needs conceptual overview    
editor/fundamentals/importing-assets Conceptual overview. Starting the doc with 3 videos isn’t ideal. You can now import anything, not just supported types."When exporting from Photoshop, make sure you’re only using vector layers" - Not true. Add note about what happens when you change layer names in Rive and reimport a PSD. 🔴  
editor/libraries This one is very confusing to people. Let’s do a full audit. 🔴  
Animation  
editor/animate-mode/animate-mode-overview Overlap with Design vs Animate page. Should be more clear about animate mode with state machines. 🔴 💛
editor/animate-mode/timeline Conceptual overview. Weird hierarchy? Add a marketplace examples 🟡  
editor/animate-mode/keys Keys and timelines seem like maybe 2 parts of the same thing, rather than needing 2 separate pages? 🟡  
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. 🟠  
State Machines ---    
editor/state-machine/state-machine The whole thing feels like it could use a rewrite. Add a marketplace example 🟠  
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 🟠  
editor/state-machine/transitions Needs description. Overview could use a note on directionality. Are conditions a separate concept? If so, add a page. Add a marketplace example. Transition condition artboard width/height/ratio undocumented. 🟡  
editor/state-machine/layers Outdated screenshots. Needs conceptual overview. Subsections not in sidebar. Add a marketplace example 🟠  
editor/animate-mode/animation-mixing Needs lots more info. 🔴  
editor/state-machine/listeners Listeners are no longer just user action. Do a more complete audit of this page. Double check that this page is up to date. The headings are weird. Like the first one is an h4, then an h3. Add a marketplace example 🟠 💛
Events --- ---  
editor/events/overview Listening should be top-level section. Overview should cover listening. Description could be more clear. Add a marketplace example 🟡  
editor/events/open-url-events Add a marketplace example 🔵  
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 🟠  
Data --- ---  
editor/data-binding/overview Add a marketplace example 🔵  
editor/data-binding/view-models Add a marketplace example 🔵  
editor/data-binding/property-types Add a marketplace example 🔵  
editor/data-binding/binding-data Add a marketplace example 🔵  
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 🟠  
editor/data-binding/converters Add a marketplace example 🔵  
editor/data-binding/stateful-components Add a marketplace example 🔵  
editor/data-binding/property-groups Add a marketplace example 🔵  
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. 🟡 💚
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. 🟡 💚
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. 🟡 💚
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 Overview could use some love. Add a marketplace example 🟡 💛
editor/manipulating-shapes/bone-tips This feels like it should get folded into bones. Maybe as a . 🟡 💛
editor/manipulating-shapes/meshes Meshes needs to go before bones. Needs a conceptual overview. Needs more how-to’s. Add a marketplace example 🔴  
editor/manipulating-shapes/joysticks Needs conceptual overview. Whole page needs a refreshAdd a marketplace example 🔴 💛
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 🟡 💚
editor/constraints/distance-constraint The hierarchy could use some love. Otherwise good. Add a marketplace example 🟡 💚
editor/constraints/scale-constraint Add a marketplace example 🔵  
editor/constraints/rotation-constraint Add a marketplace example 🔵  
editor/constraints/transform-constraint The example looks like it’s showing IK, not transform. Add a marketplace example 🟡 💛
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 🔵 💚
editor/constraints/scroll-constraint Should this live in constraints? Right now it’s in layouts. Why the link to the top-level layouts docs? 🔴 💚
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 Add a marketplace example 🟢  
account-admin/bring-your-own-bucket 🟢
editor/ai-agent/ai-agent Move FAQs to the docs, rather than linking to a blog post. Add info about where to top up credits. 🟡  
editor/ai-agent/ai-mcp 🔴  
Legacy Features --- ---  
editor/state-machine/inputs   🔵  
editor/events/general-events   🔵  

Metadata

Metadata

Assignees

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions