diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a105c415..8376519c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,8 +6,8 @@ In the first place, thank you for your interest in contributing! πŸ™ Dependencies: -* [Docker](https://www.docker.com) -* [NodeJS](https://nodejs.org) +* [Docker] +* [NodeJS] ### Build the project: @@ -87,9 +87,8 @@ application with `npm link` so you can see it in action. 1. In React UI repository, run `npm link` 2. In your application, run `npm link @react-ui-org/react-ui` -To prevent -[Invalid Hook Call Warning](https://reactjs.org/warnings/invalid-hook-call-warning.html#duplicate-react) -when React UI is linked, add the following code to your app's Webpack config: +To prevent [Invalid Hook Call Warning][react-invalid-hook] when React UI is +linked, add the following code to your app's Webpack config: ```js const path = require('path'); @@ -113,7 +112,13 @@ To keep React UI consistent and predictable the following guidelines should be o ## Documenting -We use combination of [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) -and [Docoff](https://github.com/react-ui-org/docoff) as the documentation platform. +We use combination of [Material for MkDocs][mkdocs-material] and [Docoff] as +the documentation platform. Do see their respective documentation for details. + +[Docker]: https://www.docker.com +[NodeJS]: https://nodejs.org +[react-invalid-hook]: https://reactjs.org/warnings/invalid-hook-call-warning.html#duplicate-react +[mkdocs-material]: https://squidfunk.github.io/mkdocs-material/ +[Docoff]: https://github.com/react-ui-org/docoff diff --git a/README.md b/README.md index 8bfd64e2..c5b242bc 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ React UI is a themeable, performant, responsive UI library for React apps. Use it simply with no configuration or have full control over your design by tweaking some of the hundreds theming options available. -**[Explore React UI docs β†’](https://react-ui.io)** +**[Explore React UI docs β†’][rui-docs]** ## Key Concepts @@ -38,7 +38,7 @@ these requirements:

> Development of React UI is largely supported by -> [RACOM](https://www.racom.eu)β€”one of the leading global players in wireless +> [RACOM]β€”one of the leading global players in wireless > Critical Infrastructure. ## Quick Start Guide @@ -81,8 +81,7 @@ To install React UI in your app: