EmilStenstrom
Consider moving the instructions for upgrading from pre 1.0 to another doc + point to it.
There's quite a lot of configuration to do to get this working, so simplifying things would be good.
On the docs here - https://github.com/EmilStenstrom/django-components it could be worth seperating the part that talks about older versions, i.e. "If you are upgrading from a pre 1.0 version see this doc" and have a seperate doc, since there is already quite a lot to configure.
Consider that as time goes on it's going to get rarer to need to upgrade from pre 1.0
@stuaxo Which part are you referring to? Or generally to all the bits where we explain changes in older versions?
Agree though. Once we hit 1.0.0, then I'd like to remove all mentions of pre-1.0 from the main docs. And maybe point people to the docs of the last pre-1.0 version, which would still contain such notes.
For example go here https://emilstenstrom.github.io/django-components/latest/#installation
And scroll upwards a little.
I think what it is, is that release notes are mixed in with other instructions - so whether landing on the README at github, the version on pypi or the one at https://emilstenstrom.github.io/django-components/latest/#static-files it's quite normal to scroll up and down looking through the instructions to see if anything had been missed.
Since the release notes are inline with everything else, it makes it easy to land on those as they are between quickstart and installation, so you don't necassarily expect to see some instructions there that you shouldn't follow.
On https://emilstenstrom.github.io/django-components/latest it's easier to hit that as you can click to go to various places and just land there.
It's nothing too big, just a little docs usability thing.
Sorry, in the meantime I managed to crash the documentation site 😅
I finally see what you mean! So you're talking for example about the section "Static files prior to v0.100", correct? Yeah, as I said, some of that should go away once we reach v1.
Moreover, I'm currently splitting up the README to smaller articles (see https://github.com/EmilStenstrom/django-components/pull/775), which should also make things clearer.
I think we can keep this issue open as a reminder to remove those pre-v1 notes when getting onto v1.
@JuroOravec - Do you want to keep the huge readme? I saw that you kept it in the PR that you reverted (#775 / #781).
A smaller "appetizer"-readme may be enough. I think that having the info at two places (readme + docs) has no advantage. Also on PyPI the TOC links don't work for the huge readme (#576).
A small detail: The gh-pages docs are not yet linked from the right sidebar in GitHub repo landing page (I always look there first).
@dalito Nope, I had to temporarily revert it to fix the docs building pipeline. See https://github.com/EmilStenstrom/django-components/pull/780#issuecomment-2501367416.
The intention is to have the documentation live in the Github site, and the README file will contain only the very basics / necessary stuff. See https://github.com/EmilStenstrom/django-components/pull/775
I found & fixed two bugs today that came up in v0.110. But there's one that I found*. I might try to fix tomorrow, so I don't want to re-reintrodue the reverted commit just yet.
* The remaining bug is that if you specify multiple JS scripts with a single component using Component.Media.js, then the order of scripts is not preserved. So if one script depends on the previous one, such logic will fail, because they will run in parallel.
@EmilStenstrom - You could link the new docs also from the right sidebar of the landing page under "About".