iiif-commons / notes Goto Github PK

See this post for reference/how-to.

In short, source maps make debugging minified code easier. They map generated lines and columns to the respective original lines and columns, essentially allowing something like Chrome DevTools to map a character in a generated file to a character in the original file.

In order for the components to be taken seriously, it takes more than just good documentation and quality code. They need to also make a good first impression on the demo sites and jsbins, and save devs time by limiting their need to create any CSS/patterns from scratch. Furthermore, they need to be easy for a designer/developer to add their own custom, universal styles across components to add consistency to the final app.

We should create a default atomic CSS framework and component library. This involves everything form basic HTML standards, a list of LESS variables, Sketch Template (for mockups), and identifying fundamental design patterns for ViewDir components. Less files should be available so others can create their own themes from this library (and hopefully share back).

There are many examples and blogs about this, but I'm impressed by Buzzfeed's Solid. See the Release notes... wow! I like the simplicity and size of Basscss (3.5K), which is what Buzzfeed extended.

It may be worth looking into AtomicDocs. The author pitches his approach well in this CSS-Tricks article called Style Guide Driven Development with Atomic Docs.

@edsilv what do you think about this?

I feel it would be best to keep the demos associated with the repos. It becomes harder to simply scan for the components in the repo. I suggest just component libraries, notes (issue repo), docs (gitbooks), and default styleguide (jekyll site?)... but that's why it's here to be discussed.

It's a pain to constantly have to recompile (typing gulp and gulp examples) to see your code updates appear in the browser. Webpack users get auto-compilation out of the box with Hot Module Replacement. Let's get this into the config!

This plugin looks promising:
https://github.com/AgentME/browserify-hmr

This video does a good job explaining the goodness.

Alternative approach may involve switching to Webpack? @edsilv any reason this isn't viable?

There is great interest and payoff for stateless ui, declarative methods, and reactive programming. We will need to create a component (even just proof-of-concept) to demonstrate the direction that we'd like to see components move in and the benefits it offers. @edsilv any thoughts as to what to build here?

Component maintainers need linting and testing to make it possible to collaborate. Collaborators need to know if a PR has broken anything else and adheres to style standards. Whatever we converge on would be recommended but not prescriptive. It's good to converge on one since we can provide examples and assistance to component devs.

I like standard for linting, but am open to discuss any combination of linters and test suites.

Components aren't interoperable or composable if you can't use them.

Viewdir should come up with a recommendation for licenses. MIT seems to be the least restrictive, though GPL may be more in line with the goals of the group.