On 9/8/16, 10:08 PM, "OK" <p...@olafkrueger.net> wrote:
>Hi, >I notice everyone agrees that the docs are crucial, so why not just >starting >with it instead of wasting time with discussion? ;-) > >Some thoughts to the wiki: >It is also not my favorite candidate for the docs cause it feels a bit >old-fashioned and I'm always lost while searching for something. >But the wiki is there and we could just start with it. Maybe the wiki >could >be modernized or the content could be transfered to whatever hip platform >some day. > >For the moment I would say "content first" should be the motto! > >Suggested roadmap: >- Extract all component names (strands and beads?) >- Create empty wiki pages and name it with the particular component name >- Create one example/reference documentation using a simple component >- Discuss the example and fine tune it >- Complete all the other docs with the reference as template > >I think just to have a list of all available components (with empty docs) >would be a progress. >Though my FlexJS skills are very low and my english is bad I'd try to >start >with the first point. >But there're some questions: > >1) Where the componets located? Could there be easily extracted manually >from the reop? Depending on how you look at it, each class is a component, or maybe only classes listed in manifest.xml files are components. You might get a directory listing or parse the manifest files. >2) What is a component in FlexJS? Is it a strand or a bead, or both? See above. I've been tempted to find a way to mark or annotate classes as being intended for application developers as opposed to framework developers. >3) Are beads interchangeable through any strand? Most beads are re-usable, but not necessarily to any other strand. I'm still hoping we can be more efficient about the doc. If we know there is going to be a Tour de FlexJS, we should put the examples in there as opposed to having examples in both places, and link back and forth between the doc and Tour de FlexJS, and probably the ASDoc as well. HTH, -Alex
