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

Documentation: Use Markdown instead of reStructuredText #115

Open
amotl opened this issue May 7, 2024 · 3 comments
Open

Documentation: Use Markdown instead of reStructuredText #115

amotl opened this issue May 7, 2024 · 3 comments

Comments

@amotl
Copy link
Member

amotl commented May 7, 2024

About

@matkuliak converted significant portions of the README of influxio into MyST Markdown. However, the right spot to add this to, is here.

References

@amotl
Copy link
Member Author

amotl commented May 7, 2024

We have two options:

  • Converge the content back into the repository's main README.md. Then, it would need to be converted into plain Markdown, and all MyST markup would get lost.

  • Start establishing a real documentation on this project, and add the MyST Markdown to doc/index.md.

I am preferring to use the chance to choose the second option. Can you make that happen by submitting a corresponding patch here, @matkuliak?

@amotl
Copy link
Member Author

amotl commented May 8, 2024

Documentation is there now, at https://influxio.readthedocs.io/. However, not all files have been converted to Markdown, yet.

@matkuliak
Copy link
Collaborator

Hello. Happy to see Furo used here 🙂
Of course, I can pick this up and convert anything that's still needed into MyST Markdown.

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

No branches or pull requests

2 participants