Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create an official documentation page #62

Closed
1 task done
Archmonger opened this issue Jan 31, 2022 · 0 comments · Fixed by #73
Closed
1 task done

Create an official documentation page #62

Archmonger opened this issue Jan 31, 2022 · 0 comments · Fixed by #73

Comments

@Archmonger
Copy link
Contributor

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

@Archmonger Archmonger changed the title Create docs Create an official documentation page Jan 31, 2022
@Archmonger Archmonger linked a pull request Apr 27, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant