nextflow-io / nextflow

A DSL for data-driven computational pipelines
http://nextflow.io
Apache License 2.0
2.76k stars 630 forks source link

Consider migrating docs from rst to mkdocs #2041

Closed pditommaso closed 2 years ago

pditommaso commented 3 years ago

The markdown format is more is easier to read and the Material for Mkdocs projects provide several non-intrusive extension for collapsible, tabs, callouts that make the result documentation much more readable.

To migrate rst format to markdown the following tools may help

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

abhi18av commented 3 years ago

About this one, please do let me know if there's a timeline for this - I'd be happy to take this up accordingly.

pditommaso commented 3 years ago

Thinking more, current docs just works. We may think to have a new shiny CSS layout.

abhi18av commented 3 years ago

Ah, okay. Cool, this makes sense 👍

The search experience hasn't failed so far for anything I've wanted to look in the NF docs :)

The only feedback I have is that, perhaps we should provide a visual marker (button/note) for the version, latest / edge.

pditommaso commented 2 years ago

Rewriting the docs would require to much work and introduce errors. Better to look for a nicer HTML them for the current Sphynx generated docs