Documentation Roadmap

[bhamodi]

Hey @jordangarcia, just thought it'd be nice to have a place to document our progress on the documentation website. I've added this list of things to be done, please feel free to update this list.

• [x] Create landing page.
• [ ] Create interactive example.
• [ ] Get a NuclearJS domain and create a CNAME file.
• [x] Create general documentation page explaining flux methodologies.
• [x] Create documentation page explaining NuclearJS methodologies and structure.
• [x] Reduce content in the README file and make it more like a quick summary of NuclearJS.
• [ ] Create "Examples" or "Design Patterns" section with the following:
  • Code organization (module pattern)
  • testing (unit / integration) and stubbing
  • Async actions, putting async things in action layer and making stores synchronous
  • Rest API interaction (incorporating the RestAPI example https://github.com/optimizely/nuclear-js/tree/rest-api-example/examples/rest-api)
  • Loading indicator using the loadingStore (something we've made internally)
  • Routing examples (Using react-router)
  • Isomorphic example (different module pattern, get rid of singleton reactor)
  • Hooking up NuclearJS with a different UI framework (non React)
  • Loading initial data (via reactor.loadState)
  • Persisting / syncing data with localStorage
• [ ] Add footer with copyright info.

[jordangarcia]

:+1:

[sidereus7]

I would love a React-Router example for Nuclear. That would be so helpful!!

[wesleyyee]

+1 Especially React-router 1.0 isomorphic example

[rawberg]

It would be great to have an example with Vue.js or Riot.js. Is the nuclear-vue-mixin still compatible with the latest versions of Vue and Nuclear?

[iansinnott]

It would be great to see some updated docs :+1:. The existing docs were quite helpful when I was first getting started, but it was the rest-api example that really helped me out when I started building more complex stuff with Nuclear.

I think the community could see some big wins if some of the knowledge that currently exists in the examples was made more prominent in the documentation.