You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
So as discussed on Discord a little. I think versioning is causing us a bit of pain. Main issue is that when someone uses the edit function these edits are made against the next version docs and require moving back to the 2.0.0 which are the landing version.
I've built a demo version of the docs site here from scratch and used Docusaurus 2 to do so. I ported over the conent but this is a couple of PRs out of date now but it is pretty much just a copy and paste the files job to update. Little summary
Cons
Docusaurus 2 is at a late-stage alpha at the moment, although it is pretty well documented and seemed fine to me
No translations at the moment, these are coming in Docusaurus 2 soon I believe, and I don't think they were working on the old site to be honest
I found Docusaurus 2 requires slightly stricter markdown. I.e. underscores required escaping or putting in code ticks (I see no case where the ever should not be!)
We lose the versioned docs (1.x had little in it). The can be enabled down the line if needed again if we have a version with major changes.
Pros
I was able to build a fresh version of the site with no leftovers from versioning
Docusaurus 2 has more useful behind the scenes features and more coming online
Edits done online will be in the landing version when merged with no need to port back to versioned docs
Pretty dark mode!
We lose the versioned docs!
Notes
I haven't enabled the search bar yet for the proof of concept page but this should be trivial on the deployment
The text was updated successfully, but these errors were encountered:
I really like the new look from Docusaurus. Are the current docs translated at all? I think translation would be the only major thing to consider.
I am all for dropping the versioning. I think there are better ways to handle it, like archiving the older versions and placing them in a separate location. The dark mode looks great! I don't mind the stricter syntax, anything that we move to will probably have new syntax that we will need to learn anyways.
So as discussed on Discord a little. I think versioning is causing us a bit of pain. Main issue is that when someone uses the edit function these edits are made against the
next
version docs and require moving back to the2.0.0
which are the landing version.I've built a demo version of the docs site here from scratch and used Docusaurus 2 to do so. I ported over the conent but this is a couple of PRs out of date now but it is pretty much just a copy and paste the files job to update. Little summary
Cons
Pros
Notes
I haven't enabled the search bar yet for the proof of concept page but this should be trivial on the deployment
The text was updated successfully, but these errors were encountered: