Hi all :)

Introduction

My name is Adrian and together with Piotr I am preparing a set of video
tutorials about Moonshine IDE, Royale and ActionScript. I am completely new
to this technology stack and a few days ago I was reading Royale Docs for
the first time. There were a couple of things I found confusing about the
structure of the documentation. I believe that with a few minor changes to
the docs we can achieve more clarity. If the Team agrees I volunteer to do
the changes. Here’s what I propose:

Merging Getting Started

There are two pages with awfully similar titles and responsibilities:

   -

   Getting Started [https://royale.apache.org/getting-started/] reachable
   from "Get Started" button on main Royale page
   -

   Get started with Royale [
   https://apache.github.io/royale-docs/Get%20Started.html] reachable from
   "Get Started" item in doc’s table of content.

In my opinion, the existence of two Get Started pages is very confusing. If
you agree I’d like to:

   1.

   Move all the content of Getting Started page to Get started with Royale in
   the docs
   2.

   Make Get Started button on main Royale page point to Get started with
   Royale in the docs.


Renaming Links with Instructions

On "Getting Started" page there are four links with instructions about how
to install and configure Royale in different editors. When I was reading
the docs for the first time I skipped those links because I thought they
only point to download locations, not the instructions. I’d like to rename
them as follows:

   -

   “Moonshine IDE” -> “Instructions for Moonshine IDE”
   -

   “Visual Studio Code” -> “Instructions for Visual Studio Code”
   -

   “Adobe Flash Builder” -> “Instructions for Adobe Flash Builder”
   -

   “IntelliJ IDEA” -> “Instructions for IntelliJ IDEA” [this link is empty
   but I’d keep it anyway]


Changing Menu Behavior

The Table of Content menu on the right side in the docs behaves in a weird
way. When you click on an item it doesn't automatically expand. But when
you select your topic from the main text then it expands correctly showing
all its children. At first, I thought the menu was incomplete and
disjointed but then I realized it just doesn’t expand at right times. It
made me feel a little bit lost in the docs and track my journey through
them in the notepad. If you agree I’d like to fix expanding behavior.

It's easier to conceptualize this in a video:
https://www.youtube.com/watch?v=GHzDnH8h6gE&feature=youtu.be


Have a great day,

Adrian

Reply via email to