RtkDev:Core Documentation
From RevTK
Goals
The Core documentation is not meant to be exhaustive. It was written to provide a quick reference to the MVC api.
It is edited manually for maximum readability.
The Core framework documentation
Because the documentation is itself an application, it can demonstrate components by directly including them (most useful for the front end library documentation).
- Document the framework
- Testbed for new helpers or front end components (coreJs)
- Includes code blocks that can be copy/pasted in new apps:
- Sample settings file
- Sample view configuration file
- Sample code for actions and so on.
- Documents the front end framework (coreJs)
coreJs
Core documentation also contains the documentation of the coreJs front end framework used on RevTK and next applications. Each page describes one widget or class, and demonstrates it with running code (since Core documentation is an application that can be edited).
The coreJs framework will be pulled out at some point and shared between RevTK, RevTH and the offline app using Juicer.
