[PATCH] D122990: Added new file & improved inclusivity

[Mehdi AMINI via Phabricator via llvm-commits]

mehdi_amini added inline comments.


================
Comment at: mlir/docs/README.md:1-8
+# MLIR documentation
+
+Please note [this](mlir.llvm.org) is where MLIR's rendered documentation is displayed.
+The viewing experience on GitHub or elsewhere may not match those of the
+website. For any changes please verify instead that they work on the main
+website first.
+
----------------
aaron.ballman wrote:
> Why is this file necessary? There's already a README.txt file, and none of the other top-level projects have a README.md
Note: this is a renaming of .txt to .md.

I think it is there because some people may navigate on GitHub to https://github.com/llvm/llvm-project/tree/main/mlir/docs and the README is what will be rendered there, it provides an opportunity to discourage people from browsing directly there.
It is likely that some GitHub project are designed for the doc to just render well on GitHub


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D122990