Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider migrating docs from rst to mkdocs #2041

Closed
pditommaso opened this issue Apr 14, 2021 · 5 comments
Closed

Consider migrating docs from rst to mkdocs #2041

pditommaso opened this issue Apr 14, 2021 · 5 comments
Labels

Comments

@pditommaso
Copy link
Member

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
Copy link

stale bot commented Sep 12, 2021

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.

@stale stale bot added the stale label Sep 12, 2021
@abhi18av
Copy link
Member

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

@stale stale bot removed the stale label Sep 12, 2021
@pditommaso
Copy link
Member Author

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

@abhi18av
Copy link
Member

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.

@abhi18av abhi18av added the docs label Sep 13, 2021
@pditommaso
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants