Closed
Description
Old Behavior
Currently, Django IDOM has no official documentation outside of the readme. As we continue to add features to Django IDOM, we'll need more than just a readme to encompass all our features.
New Behavior
Create new documentation.
Implementation Details
We should use the development of any one of our custom Django integration features as an excuse to create new docs.
- view_to_component() Utility Function #41
- get_component() Utility Function #40
use_database_state
hook #39use_channel_layer
hook #38use_user_state
hook #33use_session_state
hook #32
Also, these docs should contain tidbits such as
- Name parameter on
idom_component
templatetags - Explicitly state that we require a
websocket
parameter, which is different than IDOM core - Installation Instructions
- Developer's Guide
Code of Conduct
- I agree to follow the Code of Conduct.