I wouldn't link to ASDoc, but if we have a reverse-search feature, explain in the main docs how to use it.
I think your suggestions for royale-docs is fine. The advantage of having it all in ASDoc is the committer working on the component doesn't have to go to another repo to document it, but discoverability is probably more important. -Alex On 2/6/18, 10:26 AM, "Andrew Wetmore" <[email protected]> wrote: >We have created a placeholder in the documentation for migrating an >existing project from Flex to Royale. That is where I would look for such >help. Would you suggest that we add links from there to the ASDoc? That >seems a little awkward to me. > >For me, holding an existing Flex application, it would be lovely to be >able >to look in the help docs and see quickly: > >== This stuff maps to Royale stuff >== You can do this in Royale by following these steps (popups, Canvas, >title windows...) >== Royale will have these things, but does not yet (menu bar...) >== Royale will not have these things so you need to go about them in a >different way or forget about them (virtual renderers). > >This would be an exercise in capturing the tribal knowledge of the Royale >development team and making some of it available to the Alinas out there >who are hovering on the edge of Royale. > >Opinions? > > > >On Tue, Feb 6, 2018 at 2:05 PM, Alex Harui <[email protected]> >wrote: > >> I don't think we have a list. Some components are just missing (no >> Menu/MenuBar). Some components are missing things (locked rows/columns, >> virtual renderers). I don't really know how to manage such a list. The >> Spark Button has over 100 public APIs. Tracking all of that would be >> daunting. >> >> Some stuff may never happen (weak references). >> >> Some other stuff like PopUpManager can often just be done differently. >> Although if there is enough demand, we might create shims to ease >> migration pain. I know people would love it if Royale eventually had >>1:1 >> parity with Flex, but that will take quite a while and I'm just not sure >> it is worth it. We have a different pattern under-the-hood in Royale in >> order to best ensure performance in production. IMO, it would be a >> mistake to make the port compilation easy but have the results not >>perform >> well enough. We've opted for requiring a bit more work in porting code >>in >> order to try to ensure adequate performance in production. >> >> So, from Alina's emails today, some documentation around popups is >>needed. >> We've seen that question several times already Maybe a FAQ? We've >>added >> some ASDoc tags in the Royale classes (@flexdocurl and @flexcomponent >>that >> could be added to a few more components that indicate what they can >> replace from Flex. But there isn't a reverse search. A volunteer could >> add that to the ASDoc app though. >> >> My 2 cents, >> -Alex >> >> On 2/6/18, 9:26 AM, "Andrew Wetmore" <[email protected]> wrote: >> >> >Do we have a list of Flex features not (yet) available in Royale, and >> >known >> >ways of getting to the desired result using Royale? Recent >>conversations >> >regarding Alina's product migration make me think that would be a >>useful >> >feature in the help documentation. >> > >> >a >> > >> >-- >> >Andrew Wetmore >> > >> >>>https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fcottage1 >>>4 >> . >> >blogspot.com%2F&data=02%7C01%7Caharui%40adobe.com% >> 7Cab1132be823a4a9550a908 >> >d56d86b83a%7C71f1da39c0a84d5a8d88a67b23c30bf4%7C0%7C0% >> 7C636535347739075363 >> >&sdata=9GmPciqGZmuYdFrUz12LS%2FIkMACatH4VwrMoEzLllcA%3D&reserved=0 >> >> > > >-- >Andrew Wetmore > >https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fcottage14. >blogspot.com%2F&data=02%7C01%7Caharui%40adobe.com%7Cb606bc597d3e4cb895c408 >d56d8f2bbc%7C71f1da39c0a84d5a8d88a67b23c30bf4%7C0%7C0%7C636535384047818534 >&sdata=ef0S%2Fk8WdldZPH0gl79huifGOCfOt3TNcvmaNTDbY3g%3D&reserved=0
