dnskr commented on issue #7434: URL: https://github.com/apache/kyuubi/issues/7434#issuecomment-4879869748
I have created a draft [PR](https://github.com/apache/kyuubi/pull/7541) where I tested Markdown and MyST specifically for the quick-start pages and left some comments there. Markdown seems to be the right default choice for engineer-facing documentation, but it lacks the features needed to generate rich web documentation. [MyST](https://myst-parser.readthedocs.io/en/latest/index.html) (flavor of markdown) adds these necessary features, however requires additional learning. Also, MyST pages appear misformated when viewed in standard Markdown editors. From my perspective, while MyST looks like Markdown, it actually isn't. This might end up being even more confusing than standard reStructuredText (RST). Based on it, I would lean to reStructuredText as a single format for the documentation. @pan3793 @aajisaka What are your thoughts on this? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
