From 51d1dec8a5cd5b112b3d8bb9c20147ade5c93d3d Mon Sep 17 00:00:00 2001
From: Adam Kudrna
Date: Mon, 27 Mar 2023 18:02:59 +0200
Subject: [PATCH] fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup!
fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup!
fixup! fixup! Change documentation platform from Docz to Docoff
---
CONTRIBUTING.md | 19 ++++++++++++-------
README.md | 14 ++++++++------
RELEASING.md | 19 ++++++++++++-------
src/components/TextLink/README.md | 4 ++--
4 files changed, 34 insertions(+), 22 deletions(-)
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:
```
-Head to [the docs](https://react-ui.io) to see how to use, customize, and
-extend React UI.
+Head to [the docs][rui-docs] to see how to use, customize, and extend React UI.
### Development Mode
@@ -114,6 +113,9 @@ Then run webpack with the `--mode=production` or `--mode=development` flag.
We appreciate any contributions you might make. π
-Please check out our
-[Contributing Guide](https://react-ui.io/contribute/guidelines). It includes
+Please check out our [Contributing Guide][gh-contributing]. It includes
contribution guidelines and information on how to run and develop the project.
+
+[rui-docs]: https://react-ui.io
+[RACOM]: https://www.racom.eu
+[gh-contributing]: https://github.com/react-ui-org/react-ui/blob/master/CONTRIBUTING.md
diff --git a/RELEASING.md b/RELEASING.md
index 4859bd5e..baf2eb57 100644
--- a/RELEASING.md
+++ b/RELEASING.md
@@ -5,14 +5,14 @@ by bumping version number in `package.json`. However, there are several chances
to adjust both version and changelog if you wish to do so for a reason.
In order for the automation to work properly, contributors must follow the
-[contributing guidelines](/docs/contributing/).
+[contributing guidelines][gh-contributing].
## How It Works
1. Pull requests are automatically labelled by branch name. Labels are then used
for:
- 1. resolving next [semantic version number](https://semver.org)
+ 1. resolving next [semantic version number][semver]
(BREAKING.FEATURE.PATCH),
2. grouping changes in changelog.
@@ -25,11 +25,11 @@ See the source of `.github/workflows` for details.
## Release Process
1. **As you go:** make sure all contributions follow the contributing
- guidelines, especially the
- [Git workflow](/docs/contributing/#git-workflow) (correct PR names and
- branch names). Check out the release draft on
- [GitHub releases page](https://github.com/react-ui-org/react-ui/releases) to
- see what the changelog looks like and what will be the next version number.
+ guidelines, especially the [Git workflow][gh-contributing-git] (correct
+ PR names and branch names). Check out the release draft on
+ [GitHub releases page][gh-releases] to see what the changelog looks like and
+ what will be the next version number.
+
**Don't edit manually until you are ready to publish the release.** Release
draft is automatically overwritten everytime a change is merged to `master`.
@@ -62,3 +62,8 @@ See the source of `.github/workflows` for details.
**Note:** prefix version number with `v` everywhere except in `package.json` and
`package-lock.json`.
+
+[semver]: https://semver.org
+[gh-contributing]: https://github.com/react-ui-org/react-ui/blob/master/CONTRIBUTING.md
+[gh-contributing-git]: https://github.com/react-ui-org/react-ui/blob/master/CONTRIBUTING.md#git-workflow
+[gh-releases]: https://github.com/react-ui-org/react-ui/releases
diff --git a/src/components/TextLink/README.md b/src/components/TextLink/README.md
index 715bcb41..efc4fcb3 100644
--- a/src/components/TextLink/README.md
+++ b/src/components/TextLink/README.md
@@ -14,7 +14,7 @@ And use it:
```docoff-react-preview
```
@@ -34,7 +34,7 @@ It's common to use custom function for routing within SPAs. Use the
```docoff-react-preview
{
event.preventDefault();