Document routes API

[sneridagh]

---

📚 Documentation preview 📚: https://volto--6604.org.readthedocs.build/

[netlify]

✅ Deploy Preview for plone-components canceled.

Name	Link
🔨 Latest commit	cd4dbfe
🔍 Latest deploy log	https://app.netlify.com/sites/plone-components/deploys/6790cdecd8be6500089a5925

[stevepiercy]

Bringing the conversation here to keep it together with its PR.

@stevepiercy let's talk about this, because I started to write it, and it's not that easy.

For example, let's assume we start to document all the new things in Plone 7. If we mix it up with the "Plone 6" things it will be a complete mess. Specially when we will have to "switch" to Plone 7 is default eg. "https://7.docs.plone.org/"...

So I think we really need a sound strategy with this. TBH, I'd start a new completely different "Canary docs" section, going full diataxis in there.

It's easier to document the new feature in @plone/registry alone for now. I'll start doing it.

OK, I forgot we have https://plone-registry.readthedocs.io/, so we can put it there. However, if @plone/registry is for Plone 6 now, we'll still have a "complete mess", as you say, both while mixing Plone 7 with 6 stuff and when we switch to Plone 7 in this documentation.

I don't want to add a "canary" section to the current Plone 6 docs. I'd rather create a new branch 7.0 from 6.0 for all things Plone 7.

I need to add pull request previews for this repo. I think I can do it, but it could be tricky.

I'll try to review in the next couple of nights.

[stevepiercy]

how-to-guides/register-routes needs to be added to /index.md.

[stevepiercy]

I had to make a release of Plone Sphinx Theme to fix the display of the icon in the admonition. See pydata/pydata-sphinx-theme#2099

I then added support for sphinx-togglebutton.

I also added the new page to index.md.

And we now have pull request previews for the docs. However the slug in the URL that gets written back in the pull request description is for Volto, not @plone/registry. I don't know if we can fix that. You'll just have to remember to adapt the slug of the project name in the hostname of the URL to the following pattern to get a preview.

https://plone-registry--6604.org.readthedocs.build/how-to-guides/register-routes.html

Please take a look, and let me know.

[stevepiercy]

@macagua https://www.rietveldschroderhuis.nl/en is not loading, and you added it in https://github.com/collective/awesome-volto/blame/4332d4158d517802f8532c6966f7c30f05206f0d/README.md#L227.

It appears to be a site created by INTK. @andreesg @ruibeep @simonbrunel from INTK, I found your GitHub usernames from the INTK GitHub organization, and assume that you will soon be aware of the downtime when you wake up this morning. https://github.com/intk/intk-upptime?tab=readme-ov-file

For us in Volto, we can ignore this readme linkcheck warning for now.

[stevepiercy]

I purged the now unnecessary togglebutton extension and config.

I also fiddled with the wording and grammar.