Enhancements to/redesign of Fluid Infusion demo pages

James William Yoon jyoon at ocad.ca
Mon Nov 8 19:47:09 UTC 2010


Thanks for your feedback, Anastasia! Comments inline.

On Thu, Nov 4, 2010 at 10:31 AM, Cheetham, Anastasia <acheetham at ocad.ca>wrote:

> > - Provide useful, succinct code snippets + ultra-light documentation to
> give integrators a taste for how easily the component can be inserted and
> manipulated
>
> The code itself, and the mark-up, need to have more "documentation-style"
> comments in them. This is one place where we do want to state what might be
> obvious to *us*.
>

This makes a lot of sense. Do you think it'll add a lot of length to the
code?


> Another thing we plan to do is use the demo code as the basis for a
> tutorial that will walk the reader through all that needs to be done. Do you
> think more instructive comments plus a link to a tutorial would address this
> point?
>

Yes, that'd be fantastic.


> > - Package the full demo code and make it available for download and
> tinkering (we might consider adding a readme or other documentation to
> accompany the package).
>
> The demo code is already part of the downloadable Infusion bundle, in a
> top-level folder called "demos." Do you think this is adequate, or are you
> thinking of something else?
>

I'd forgotten that the demos were part of the bundle. This is probably
adequate, though a note that the demo can be found in the bundle should
probably be added (as well as a link to the builder or a direct link to the
full Infusion package)


> > Also, I suspect that making the complete code available for reading
> directly beside the demo may not be as useful as we might've initially
> reasoned. It'll be a good deal of code once we finish implementing the new
> component designs Jonathan has been coming up with, and the initial demo
> page may not be the choice environment for an integrator to look through all
> that code. Succinct pieces of relevant code might have better impact.
>
> We've actually had feedback from users that the current demo portal is
> "incredibly helpful." I think we do need to try to keep the demos as clean
> as possible, and simple enough to minimize code that's unrelated to the
> component we're actually demonstrating. Also, clear comments stating "Here's
> where the component is being used" will help reader to separate the wheat
> from the chaff.
>

This is great to know. Are users particularly happy about having the code
side-by-side with the demo? I can see it being useful, I'm still a bit
concerned about the length of code after the demo redesigns. And with all
the extra content we're hoping to stuff in, prime real estate will become
rather in demand. Let's see what we can do to play around with this.

James
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://fluidproject.org/pipermail/fluid-work/attachments/20101108/498f256b/attachment.html>


More information about the fluid-work mailing list