jobara
commented
3 months ago Comment Migrated from FLUID-5215 originally posted by @acheetham on November 20, 2013
We discussed this in the Community Meeting on Nov. 20 and came up with the following overall hierarchy: src framework components lib module demos showcase instructional integration <- to be destroyed standalone tests For the demos/instructional folder, the hierarchy should mirror, as much as reasonable, the hierarchy of the source folder. In general: demos/instructional framework core prefs renderer components componentX shared css shared.css html shared.html js shared.js demoX css file.css html file.html js file.js demoY css file.css html file.html js file.js componentY etc
We would like to create instructional demos that would serve as working examples of how to accomplish various common tasks in Infusion. The intention would be for each individual instructional demo to teach a single thing, for example, how to customize one feature of a component. The goal would be for the code to be clear, simple, self-contained, well-commented and illustrative of best practices. These demos would be referenced by documentation and tutorials.
Having each demo illustrate a single thing would result in a lot of small demos, which might result in code duplication. We should consider the possibility that any refactoring to reduce this duplication would likely obfuscate the code a bit, going against the goals of clear, simple and self-contained. We should attempt to carry out any such refactoring to minimize complication and obfuscation.
Additional context or notes
Originally filed as FLUID-5215 by @acheetham on November 20, 2013.