diff options
Diffstat (limited to 'docs/guide/index.md')
| -rw-r--r-- | docs/guide/index.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/guide/index.md b/docs/guide/index.md new file mode 100644 index 00000000..6cf2197c --- /dev/null +++ b/docs/guide/index.md @@ -0,0 +1,33 @@ +--- +sidebarDepth: 0 +--- + +# Getting Started + +This guide outlines the architecture and technologies used to build the OpenBMC Web UI. This guide exists to serve the following goals: + +1. Improve contributor efficiency while maintaining the quality and consistency of the user interface +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/) +- [Axios](https://github.com/axios/axios) +- [Bootstrap-vue](https://bootstrap-vue.js.org/) +- [Vuelidate](https://vuelidate.js.org/) +- [Vue I18n](https://kazupon.github.io/vue-i18n/) + +::: tip +Acquiring an understanding of these technologies will also be necessary. +::: + +You will find more information about the standards and best practices in the [Coding Standards section of this guide](/coding-standards/). + +## Guidelines +The [guidelines section](/guide/guidelines) contains the OpenBMC community agreed-upon decisions on color and typography within the application. How to theme the application to meet company brand guidelines is documented in [Themes](/themes). + +## Components +The [components section](/guide/components/) is a guide to using both custom Vue components and components from the Bootstrap-Vue library. + |