Document

[chriskrycho]

• [ ] document principled-forms
  • [ ] README – overview of aims and structure, including the relationship of the layers of abstraction and the use of types
  • [ ] Guide – how to use each of the modules, including a description of its role in the abstraction alyer
  • [ ] API docs
    • [x] form
    • [ ] field
      • [ ] Field (at root)
      • [ ] Email
      • [ ] Number
    • [ ] validity
    • [ ] validators
• [ ] publish docs
  • [ ] use ember-cli-addon-docs for principled-forms
  • [ ] ember-cli-addon-docs build for ember-principled-forms

[chriskrycho]

Those last two probably will just be done together – by pointing to it as an ember-addon-docs "package" – as done in the addon-docs own repository here; this is private API but likely to stabilize soonish, and we should be able to just reuse the same docs source for both the Ember form implementation and the underlying library.