[PATCH] D74739: [mlir] Add short readme.txt to docs directory

Jacques Pienaar via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Mon Feb 17 13:25:05 PST 2020


jpienaar created this revision.
jpienaar added a reviewer: mehdi_amini.
Herald added subscribers: llvm-commits, Joonsoo, liufengdb, aartbik, lucyrfox, mgester, arpith-jacob, nicolasvasilache, antiagainst, shauheen, burmako, rriddle.
Herald added a project: LLVM.

Refer folks to the main website and make it explicit that the rendered
output is what is of interest and that the GitHub viewing experience may
not match (even though we are trying to keep it as close as possible, the
renderers do differ).


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D74739

Files:
  mlir/docs/README.txt


Index: mlir/docs/README.txt
===================================================================
--- /dev/null
+++ mlir/docs/README.txt
@@ -0,0 +1,9 @@
+MLIR documentation
+==================
+
+Please note 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.
+
+See https://github.com/llvm/mlir-www for the website generation information.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D74739.245028.patch
Type: text/x-patch
Size: 518 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200217/fee40498/attachment.bin>


More information about the llvm-commits mailing list