[PATCH] D122990: Added new file & improved inclusivity

[Aaron Ballman via Phabricator via llvm-commits]

aaron.ballman added a comment.

Most of the changes LGTM, the only concerns I have left are around the READMEs. One thing we could do is split the question about what to do with READMEs off into a separate patch so that we can land the straightforward fixes now, if you'd like.



================
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.
+
----------------
mehdi_amini wrote:
> 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
> Note: this is a renaming of .txt to .md.

Thanks, I had missed that!

> 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

That makes sense, but then I think we should be consistent with all of the README.txt files in the repo. WDYT?


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D122990