diff options
| author | Derick Montague <derick.montague@ibm.com> | 2021-03-17 03:52:33 +0300 |
|---|---|---|
| committer | Derick Montague <derick.montague@ibm.com> | 2021-03-22 16:27:10 +0300 |
| commit | 492875622b39cb2cf04bbb9248b6ed0c52ced2df (patch) | |
| tree | 665449e11841591a8aae5f4f347a3a88936a2d7a /docs/guide/readme.md | |
| parent | b0fadef1f96df99ff5eb0637527f04bc793c8d6e (diff) | |
| download | webui-vue-492875622b39cb2cf04bbb9248b6ed0c52ced2df.tar.xz | |
Update text wrapping in documentation
To meet best practices and standards for markdown, this commit updates
all markdown files used for the VuePress documentation so that each
line is limited to 80 characters.
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I0cadb33343ce1bc331dfefd096d8137a04c33604
Diffstat (limited to 'docs/guide/readme.md')
| -rw-r--r-- | docs/guide/readme.md | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/docs/guide/readme.md b/docs/guide/readme.md index 301dc9a4..bba15749 100644 --- a/docs/guide/readme.md +++ b/docs/guide/readme.md @@ -4,13 +4,17 @@ 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: +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. 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: +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/) @@ -19,15 +23,19 @@ Having an understanding of semantic HTML, CSS, and JavaScript is the critical kn - [Vuelidate](https://vuelidate.js.org/) - [Vue I18n](https://kazupon.github.io/vue-i18n/) -::: tip -Acquiring an understanding of these technologies will also be necessary. +::: 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](/guide/coding-standards/). +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) 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 [Themes](/themes). +The [guidelines section](/guide/guidelines/colors) 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 [Themes](/themes). ## Components -The [components section](/guide/components/) is a guide to using both custom Vue components and components from the Bootstrap-Vue library. +The [components section](/guide/components/) is a guide to using both custom Vue +components and components from the Bootstrap-Vue library. |