summaryrefslogtreecommitdiff
path: root/docs/guide
diff options
context:
space:
mode:
authorDerick Montague <derick.montague@ibm.com>2020-03-04 03:19:20 +0300
committerDerick Montague <derick.montague@ibm.com>2020-03-10 03:10:04 +0300
commit8326855ba5f82dbfbfcfe2b65e49e9a30d9bf710 (patch)
tree754bb0ed6fae0240601380efa51df282583c5987 /docs/guide
parent702ba3ee5126449ef6df744d4ae4766ddba7dfb1 (diff)
downloadwebui-vue-8326855ba5f82dbfbfcfe2b65e49e9a30d9bf710.tar.xz
Add component overview documentation
Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I02de80a70acc0d6e3d1278acb33bbbb004c106b4
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/components/index.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/guide/components/index.md b/docs/guide/components/index.md
index 4bba659e..f10a1317 100644
--- a/docs/guide/components/index.md
+++ b/docs/guide/components/index.md
@@ -1 +1,4 @@
-# Overview \ No newline at end of file
+# Overview
+Vue components are the building blocks of the OpenBMC Web UI. It uses both Boostrap-Vue components, as well as custom components. Using these components assures consistency throughout the application. They also improve the developer experience and increase efficiency. Review the existing components before using HTML markup. If the feature you're working on includes a new layout pattern, rather than adding raw markup to the page, consider creating a component that other sections of the application can use as well.
+
+[Learn more about Vue components](https://vuejs.org/v2/guide/components.html) \ No newline at end of file