Hi, I would like to share an idea I had for a cleaner, more readable and useable API page layout. I have attached a pdf mockup of what a sample might look like - even though some of the data is real, it's just filler.
There are a few things I would like to emphasize from this concept: * Almost all categories are collapsible, enabling a customized reading experience * Overview meta data is stored at the top with a contextualized help link (?) * JIRA issues for the code in question are quickly accessible * There is a Glossary of terms unique to Infusion and the specific content of the page. Some are unique to the framework, others might just be explanations (in this mockup the [Selector] link would point to a glossary definition saying something like "type Selector = String, jQuery Object, Element, or Function returning an Element or jQuery Object") * Color coding * Explicitly obvious nested structures These ideas are just conceptual. Implementation is an entirely different concern. This is a very rough draft, so all feedback is very welcome! Thanks Jacob
C:\\Documents and Settings\\Jacob\\Desktop\\docs.pdf
Description: C:\Documents and Settings\Jacob\Desktop\docs.pdf
_______________________________________________________ fluid-work mailing list - [email protected] To unsubscribe, change settings or access archives, see http://fluidproject.org/mailman/listinfo/fluid-work
