Documentation - wiki should line up with main API/behavior

[agallant]

This is a "meta" issue to track documenting freedom.js behavior. Right now there are significant aspects of freedom.js that are not explained on the wiki. For example, module cleanup/teardown: https://github.com/freedomjs/freedom/issues/295

Goals:

• Figure out what isn't documented, and at least stub out basic documentation for it
• Identify inconsistencies and gaps in both functionality and documentation
• Polish, and maybe publish to something besides the wiki (e.g. https://readthedocs.org/ http://readme.io/ etc/)

This is a bit separate from the tutorial, which is more of a "getting started"/basic freedom.js-consumer example - this documentation should ultimately be comprehensive and useful to developers that are going deep in freedom.js-land, not just using it externally.

Linked-but-nonexistent wiki pages

• [x] Tutorial: Cross Platform
• [x] Existing API providers
• [x] Publishing freedom.js modules
• [ ] freedom.js structure: environment
• [ ] freedom.js structure: module
• [ ] freedom.js structure - policy
• [ ] freedom.js structure - debug
• [ ] freedom.js structure - links
• [ ] freedom.js structure - hub
• [ ] freedom.js structure - api
• [ ] freedom.js.structure - packaging

  Existent-but-should-be-extended wiki pages

• [ ] Common issues
• [ ] Debugging
• [ ] Provider Testing
• [ ] Logging
• [ ] Compiling freedom.js (specifically adding platform/flavor specific notes)
• [ ] freedom,js structure and its subpages
• [ ] Tutorial: View API

[agallant]

@willscott @ryscheng just giving you a heads up on this, my intent is to either complete articles or remove links to them. Since one of you presumably made the link(s) in the first place I may have questions about what you were envisioning as content - most of it is clear, but one in particular I'm unsure about is "Publishing" (linked to as "Publishing freedom.js" from the bottom of the main wiki). Do you just mean guidelines around releasing freedom.js-powered apps, or something about publishing freedom.js itself?

[willscott]

I think publishing apps / modules.

On Fri, Sep 25, 2015 at 9:30 AM, soycode notifications@github.com wrote:

@willscott https://github.com/willscott @ryscheng https://github.com/ryscheng just giving you a heads up on this, my intent is to either complete articles or remove links to them. Since one of you presumably made the link(s) in the first place I may have questions about what you were envisioning as content - most of it is clear, but one in particular I'm unsure about is "Publishing" (linked to as "Publishing freedom.js" from the bottom of the main wiki). Do you just mean guidelines around releasing freedom.js-powered apps, or something about publishing freedom.js itself?

— Reply to this email directly or view it on GitHub https://github.com/freedomjs/freedom/issues/296#issuecomment-143269834.