Roku Developer Program

Developers and content creators—a complete solution for growing an audience directly.
cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 
RokuTomC
Roku Employee
Roku Employee

Planned enhancements to the developer documentation

Hello Roku Developers,

Thank you for your feedback on the new developer documentation site that launched last month. We’ve been listening closely to your comments, and wanted to provide an update on some enhancements you can expect to see in the coming weeks.

Planned improvements
Below is a list of UI enhancements and new features that we plan to implement, stack-ranked according to priority:

    • Improve the styling for tables:

        • Make tables responsive; prevent horizontal scrolling on tables except for exceptionally large tables (such as the hardware specifications table)

        • Top-justify text within each cell

      • Apply width precedence to columns with cells with lots of text

 

    • Drastically increase max width of the body container; minimize unused whitespace on the left- and right-hand sides

 

    • Render the left- and right-hand menus as collapsed when first landing on a new page on a mobile device; optimize menu navigation for mobile experience

 

    • Enable developers to directly contribute content and corrections to the documentation site (POSTPONED)

 

    • Apply fixed position to the left-hand navigation menu

 

    • Open search results in the same tab when clicked

 

  • Make titles of search results clickable



Additionally, we are tracking the following bugs for resolution:

    • The right-hand menu in Safari jumps left after scrolling below the fold

 

  • In Chrome on PC, entries in the right-hand table of contents do not bring the user to the correct anchor point



Feedback is welcome
This thread will remain open until community feedback tapers off significantly. Please continue sharing your feedback with us in the coming weeks. Even if a suggestion has already been recommended by someone else, there is value in putting in an additional request, as it will help us set priority on the most critical updates. Let us know if you believe the above-listed stack ranking of priorities should be adjusted.

0 Kudos
5 REPLIES 5
taylorcw
Level 9

Re: Planned enhancements to the developer documentation

Tom, so far the new documentation layout looks good to me.

On content, I noticed a bug in the documentation which had me hung up for a little while. 
https://developer.roku.com/docs/referen ... usevent.md

All references to ifCECStatus.IsActiveSource() should be:  CECStatus.IsActiveSource()

Thanks
0 Kudos
infoman
Level 8

Re: Planned enhancements to the developer documentation

Are the samples going to be updated to pass your certification (the required roInput event handling is something I'm currently trying to figure out)?
Baradanikto
Level 13

Re: Planned enhancements to the developer documentation

Any chance that a subscription model can be used for the documentation.  When the old feed spec documentation was hosted on GitHub, it was very helpful to be able to "follow" any changes made to it.  With the current documentation, there's no way to know if something has changed without occasionally checking.
FREE Windows desktop software for creating BIF (Trick Play), Direct Publisher (MRSS, JSON), and FireTV feeds @ GitHub/rrirower. No programming knowledge required.
0 Kudos
RokuTomC
Roku Employee
Roku Employee

Re: Planned enhancements to the developer documentation

"Baradanikto" wrote:
Any chance that a subscription model can be used for the documentation.  When the old feed spec documentation was hosted on GitHub, it was very helpful to be able to "follow" any changes made to it.  With the current documentation, there's no way to know if something has changed without occasionally checking.

Thanks for the suggestion — it's one we're looking into internally as well. There are no commitments at the time, but we hope to roll out a feature like this eventually.
0 Kudos
RokuJonathanD
Roku Employee
Roku Employee

Re: Planned enhancements to the developer documentation

Happy new year! We just completed some cleanup on the formatting of the BrightScript API docs. This minimizes the amount of nested tables and thus scrolling to see method and parameter descriptions. 

0 Kudos