Stream: docs

Topic: future docs ideas


view this post on Zulip Oliver Bertuch (Jul 25 2024 at 20:11):

Is it in scope for this working group to talk about some larger tasks about docs?

On my mind are things like

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 25 2024 at 20:12):

Absolutely!

view this post on Zulip Oliver Bertuch (Jul 25 2024 at 20:18):

Great. I'm happy to throw in effort where possible (my plate's already quite full) and try to convince more people to welcome/encourage this. Some serious community efforts in these areas would be great. I've been with this project for so long, I start to ignore the flaws of our docs as I know my way around.

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 25 2024 at 20:42):

Lots of flaws but we can improve them bit by bit. :grinning:

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 25 2024 at 20:42):

We do have the ability to migrate from .rst to .md already, by the way. The Contributor Guide is written in Markdown, for example.

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 25 2024 at 20:54):

Speaking of switching away from Sphinx, @kuhlaid created this issue:

Feature Request/Idea: switching from Sphinx docs to using Docusaurus #8905

He even made a prototype: https://dataverse-docusaurus.vercel.app/docs/user-guide/account

This is a whole topic, of course, switching away from Sphinx, but I'd feel remiss if I didn't mention it. :grinning:


Last updated: Nov 01 2025 at 14:11 UTC