Skip to content

Create an official documentation page #62

Closed
@Archmonger

Description

@Archmonger

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.

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions