[Mlir-commits] [mlir] fa7d04a - [mlir] Add short readme.txt to docs directory

[Jacques Pienaar]

Author: Jacques Pienaar
Date: 2020-02-18T08:35:22-08:00
New Revision: fa7d04a0d3f40d1b9997775f24e9c6032011e15f

URL: https://github.com/llvm/llvm-project/commit/fa7d04a0d3f40d1b9997775f24e9c6032011e15f
DIFF: https://github.com/llvm/llvm-project/commit/fa7d04a0d3f40d1b9997775f24e9c6032011e15f.diff

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

Summary:
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).

Differential Revision: https://reviews.llvm.org/D74739

Added: 
    mlir/docs/README.txt

Modified: 
    

Removed: 
    


################################################################################
diff  --git a/mlir/docs/README.txt b/mlir/docs/README.txt
new file mode 100644
index 000000000000..52e11d6c6f47
--- /dev/null
+++ b/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.