summaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2019-07-15 07:50:28 -0700
committerGitHub <noreply@github.com>2019-07-15 07:50:28 -0700
commitcbb0528d32576d146920cfdbc3964644a39c5d11 (patch)
tree22727ba24ca1b36cdc3ab502c0bf4bcc0084ca44 /docs/README.md
parent80e66747d55c428c54fc215b2c3662785e067ea9 (diff)
Styling improvements to documentation (#6425)
* Changed mkdocs theme * Added custom styles for various elements * Moved to different syntax highlighting plugin * Added a README for the docs/ folder to direct people to the docs site * Change highlight theme
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000000..8dd0c7a634
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,7 @@
+# Read documentation on https://docs.netdata.cloud
+
+Welcome to the Netdata documentation! While you can read Netdata documentation here, or throughout the Netdata repository, our intention is that these pages are read on [docs.netdata.cloud](https://docs.netdata.cloud).
+
+Links between documentation pages will work fine here, but the formatting may not be perfect, as our documentation site uses a few extra Markdown features that GitHub doesn't support natively. Other things might be missing or look less than perfect.
+
+Now get out there and build an exceptional infrastructure. \ No newline at end of file