MultiQC docs: add modules index page

[vladsavelyev]

Use a modules index page built here MultiQC/MultiQC#2903 instead of a sidebar section.

[netlify]

✅ Deploy Preview for seqera-docs ready!

Name	Link
🔨 Latest commit	d8cebfb
🔍 Latest deploy log	https://app.netlify.com/sites/seqera-docs/deploys/67067a5ce33fcc0008fd9a57
😎 Deploy Preview	https://deploy-preview-246--seqera-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[ewels]

Great work, this looks much better! 👏🏻

Main downside I see in the deployment preview is that the module pages no longer show the sidebar, eg. here. This is a bit of a problem as you suddenly can't navigate elsewhere in the docs.
I think / hope that we can solve this by adding displayed_sidebar: multiqcSidebar to the markdown frontmatter (docs).

Minor, not blocking: It'd be great to have a filter for the table like in the old page 🤔 Can look into that in the future though.

[vladsavelyev]

I think this solves all the problems: MultiQC/MultiQC#2904

Adds a reasonable index (also the "development/index" page is not so uninformative), and the sidebar main items are now clickable.

[justinegeffen]

Thanks for this PR! Is it possible to turn the expand arrows in a different direction? They face inward ">" and are large while the other doc sets use small ">"s.

[vladsavelyev]

We can tweak CSS for sure, but that's just the default Docusaurus style, and there is a benefit in using the default, as the website immediately looks familiar to those who have seen other Docusaurus backed docs :)

[ewels]

I've been trying to get away from the term "Modules" as it means so many different things. With the unified search it'll also come up for nextflow modules, nf-core modules, etc etc.

Is there a reason to move away from "Supported Tools"?

[vladsavelyev]

We call them "Modules" elsewhere in the docs and the codebase, e.g. "Writing new modules" in the development section.

So I'd say if we want to move away, we would be moving away from "Modules" :) Happy to give it a shot at least across the docs. E.g. "Writing new modules" -> "Adding tools", etc.

[ewels]

Yeah, maybe you're right and we should move away entirely.

I'd at least like to leave this page as "Supported Tools" anyway. The folks looking for these pages are typically end users and not developers. I think "Supported Tools" is more user friendly and intuitive.

[justinegeffen]

We can tweak CSS for sure, but that's just the default Docusaurus style, and there is a benefit in using the default, as the website immediately looks familiar to those who have seen other Docusaurus backed docs :)

I think we've tweaked the style on our side already - hence the difference. I'm happy with either option but it should be consistent.

[ewels]

There aren't any changes to the styling here, I guess the arrows are reverting because of the addition of "link": { "type": "generated-index", }, in the config.

@vladsavelyev why was this needed? I think I'll need to go into the theme customisation and add support for this explicitly I guess.

[ewels]

And before going much further - whilst I agree this is an improvement I still don't like it as much as the old MultiQC equivalent page.

I would prefer to hand-code a table view that looks like the one we had before, and remove the tool names from the side nav.

We should be able to still have functionality like the filter box etc. We can write custom React components in the Docusaurus theme as needed, then build the HTML / MD in the MultiQC repo accordingly. I can take a look at this if needed, though might be post-summit now.