hotwire-django / turbo-django

Unmaintained // An early stage integration of Hotwire Turbo with Django
https://discuss.hotwire.dev/t/django-backend-support-for-hotwire/1570/
Other
385 stars 20 forks source link

Move documentation to readthedocs.io #15

Closed davish closed 3 years ago

davish commented 3 years ago

I'm partial to mkdocs with its focus on markdown but, but am open to discussion on this!

JulianFeinauer commented 3 years ago

Personally I prefer markdown too but if somebody is able to set it up the "python way" (sphinx and remarkable or how its called) @danjac twinkle, twinkle I would prefer that, I think.

C4ptainCrunch commented 3 years ago

I've never used mkdocs but i do indeed prefer writing Markdown than RST. I guess we should do a vote here as it has big consequences (i'm already voting blank ^^)

If we go the RST+Shpinx i volunteer to do the setup with readthedocs, i'm quite used to it.


Other question (that we might not want to solve here or now): should we do something like hotwire.dev where there is a landing page linking to each project docs ? Should we also buy a .dev domain (i'm explicitly not writing the domain name here, don't want a 🤖 picking it up and buying the domain before us)

C4ptainCrunch commented 3 years ago

So it seems like @davish and @JulianFeinauer prefer Markdown but @danjac uses Sphinx in hotwire-django/django-turbo-response. Should we do a formal vote ? The one that implements it just chooses ?

JulianFeinauer commented 3 years ago

Documentation is now here in a first version: https://turbo-django.readthedocs.io/en/latest/