[flang-commits] [PATCH] D85828: [Flang] Move mark down documentation(md) files to reStructuredText(rst) file format.

[Mehdi AMINI via Phabricator via flang-commits]

mehdi_amini added a comment.

In D85828#2213275 <https://reviews.llvm.org/D85828#2213275>, @DavidTruby wrote:

> In D85828#2213245 <https://reviews.llvm.org/D85828#2213245>, @sscalpone wrote:
>
>> I think md is the wave of the future.  Other llvm subproject use md.  Let's stick with what we have unless there's a compelling advantage to using rst or another format.
>
> It's not really correct to say that other llvm subprojects use md: with the exception of MLIR every LLVM subproject uses rst, including LLVM itself.
>
> MLIR hosts a separate website elsewhere, which is why they aren't tied to the same format as everyone else. If we want to do that and render the .md files to html instead then we can, but if we want to be on the same website as the rest of LLVM (except MLIR) we need to use rst as the text format.
>
> That is, at least, my understanding for the motivation behind the change. @sameeranjoshi can probably provide a better explanation as it's his change.

Both website are serving HTML: as long as you generate HTML you can serve easily either way.

LLVM is using Sphinx to turn its documentation from RST to HTML and copy this to the webserver.
MLIR is using Hugo <https://gohugo.io/> (see mlir-www <https://github.com/llvm/mlir-www/>) to turn its .md into HTML and serve it directly from GitHub pages.

There aren't any real underlying technology from the website point of view, MLIR could be hosted with LLVM as well, and use the same theme, etc.

The use of Markdown in MLIR is mostly historical I believe (Google uses heavily markdown for its doc and MLIR started at Google).

The use of GitHub pages instead of llvm.org is because the admins told me back in the fall when I was setting up the website that "it would be nice to migrate llvm.org to GitHub pages".


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D85828/new/

https://reviews.llvm.org/D85828