summaryrefslogtreecommitdiff
path: root/docs/guide/components/readme.md
diff options
context:
space:
mode:
authorDerick Montague <derick.montague@ibm.com>2020-04-18 00:49:15 +0300
committerDerick Montague <derick.montague@ibm.com>2020-05-15 00:47:04 +0300
commitb115aea1eab526971983369986e2d2a56e17ff15 (patch)
tree29e3298a5208306a5dae9b55cf1075844ab348a0 /docs/guide/components/readme.md
parent20d8c1867088f47cd970e7cf76a0f8c0c723b6f7 (diff)
downloadwebui-vue-b115aea1eab526971983369986e2d2a56e17ff15.tar.xz
Add themes documentation
- Renamed all index.md to readme.md to make consuming the documentation from the Github repo easier. VuePress treats index.md and readme.md the same way when building the static pages. - Added theme section overview documentation - Added how to customize documentation - Added custom style imports to support OpenBMC Web UI component documentation to remove Bootstrap framework base styles that conflict with the Vuepress theme - Found occurrences of the word Sass in upper-case and changed to use sentence case. Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: If5588f88a3d75761cc47e85a3fb0a582b31d373c
Diffstat (limited to 'docs/guide/components/readme.md')
-rw-r--r--docs/guide/components/readme.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/guide/components/readme.md b/docs/guide/components/readme.md
new file mode 100644
index 00000000..f10a1317
--- /dev/null
+++ b/docs/guide/components/readme.md
@@ -0,0 +1,4 @@
+# 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