summaryrefslogtreecommitdiff
path: root/docs/guide/readme.md
diff options
context:
space:
mode:
authorPatrick Williams <patrick@stwcx.xyz>2022-12-08 15:13:13 +0300
committerPatrick Williams <patrick@stwcx.xyz>2022-12-08 15:13:13 +0300
commit7385e139b0c9efca7430458cee982e63e282f4ae (patch)
tree1bbdb0164e556b76eec72cb558c66974c8f95dd8 /docs/guide/readme.md
parentb24a483eda5ca0b0ecdb4f0c61b90d76d0d8e1e0 (diff)
downloadwebui-vue-7385e139b0c9efca7430458cee982e63e282f4ae.tar.xz
prettier: re-format
Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML files to have consistent formatting for these file types. Re-run the formatter on the whole repository. Change-Id: I2804ee3ab5ff6bcbf986b028db2fafec8e616779 Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Diffstat (limited to 'docs/guide/readme.md')
-rw-r--r--docs/guide/readme.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/guide/readme.md b/docs/guide/readme.md
index 0a0db1d7..19c481c2 100644
--- a/docs/guide/readme.md
+++ b/docs/guide/readme.md
@@ -12,9 +12,11 @@ Web UI. This guide exists to serve the following goals:
1. Act as a collection of community agreed-upon standards
## Coding Standards
+
Having an understanding of semantic HTML, CSS, and JavaScript is the critical
knowledge required to contribute to this project. The frameworks and libraries
used to build this UI include:
+
- [Vue](https://vuejs.org/)
- [Vuex](https://vuex.vuejs.org/)
- [Vue Router](https://router.vuejs.org/)
@@ -30,12 +32,13 @@ You will find more information about the standards and best practices in the
[Coding Standards section of this guide](/guide/coding-standards/).
## Guidelines
+
The [guidelines section](/guide/guidelines/colors.md) contains the OpenBMC
community agreed-upon decisions on color, motion, and typography within the
application. How to theme the application to meet company brand guidelines is
documented in [Customization](/customization/).
## Components
+
The [components section](/guide/components/) is a guide to using both custom Vue
components and components from the Bootstrap-Vue library.
-