dgw
commented
11 months ago mrw @Exirel adds something new to the 8.0.0 milestone:
https://github.com/sopel-irc/sopel/assets/164140/39a0d31f-d226-4cc6-b6e4-6bb8aa22d583
I'm not super attached to the current site, other than it being nostalgic (the basic structure is the same as what existed when I took over from the previous maintenance team). Automatic deployment of just the Sphinx docs is very much easier, as proven by our use of https://unstable.docs.sopel.chat/ (with deploy previews for every PR, and the main domain updated every time something's merged). I don't think it'd be too hard to shift sopel.chat itself over to auto-deploy only on release—maybe using another GHA workflow with https://github.com/netlify/actions.
promote "official" plugins
Have a poke around https://github.com/sopel-irc/plugin-db (for now, the prototype branch) to see some past work regarding a proper plugin list. Fair warning: I last touched it almost 3 years ago, before I learned a lot more about static site generator tools. Regardless of what's under the hood and what still builds (or not), there is still a preview of the WIP version at https://prototype.plugins.sopel.chat/.
ghost
Exirel
Requested Feature
I'd like, for Sopel 8, to move part of the website's documentation into the project's documentation. The goal of this issue is to discuss which sections/parts we want exactly. I'd like to have a curated list of frequent issues and errors our users encountered in the past, things that we always have to answer to.
For instance, I'd like to improve the running the bot chapter with the following sections and information:
I also think we could rework a bit our contribution guide, for example to add the appendix about the core plugin.
Maybe even... have a Design Document that outline the core tenet of Sopel's software architecture? Well... maybe not right now, but that would be lovely to consider!
As for the website, I think we could use it more to promote Sopel's feature, promote "official" plugins, share some links... I believe it still has a place and could be useful. It could also be used to host a sopel-help generated html page. That's something for another issue tho.
Problems Solved
Today, there are two locations for our documentation, and that's one too many in my opinion. So moving everything (or at least the most relevant things) into one place would solve that issue. It would streamline the workflow of upgrading the doc at the same time as the code.
Alternatives
Keep the website and upgrade it as we go, which we don't really do as it's separate from the code and all, and we have to keep the doc for the current version released, it means having open PR and stuff. So maybe we should change our workflow a bit to make it easier. But that's only the alternative here!
Notes
I was supposed to make a PR for 2497 but I think it's better to talk about that before really diving into that. I'd love some feedback and ideas to write this part of the documentation.