Skip to content

Commit

Permalink
fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup!…
Browse files Browse the repository at this point in the history
… fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! Change documentation platform from Docz to Docoff
  • Loading branch information
adamkudrna committed Mar 27, 2023
1 parent a0d1de0 commit 51d1dec
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 22 deletions.
19 changes: 12 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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');
Expand All @@ -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
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -38,7 +38,7 @@ these requirements:
</p>

> 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
Expand Down Expand Up @@ -81,8 +81,7 @@ To install React UI in your app:
<Button label="My Button" />
```

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

Expand Down Expand Up @@ -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
19 changes: 12 additions & 7 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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`.

Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions src/components/TextLink/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ And use it:

```docoff-react-preview
<TextLink
href="/docs/contributing/"
href="/docs/contribute/general-guidelines"
label="How can I contribute to React UI?"
/>
```
Expand All @@ -34,7 +34,7 @@ It's common to use custom function for routing within SPAs. Use the

```docoff-react-preview
<TextLink
href="/docs/contributing/"
href="/docs/contribute/general-guidelines"
label="This link is controlled by custom function"
onClick={(event) => {
event.preventDefault();
Expand Down

0 comments on commit 51d1dec

Please sign in to comment.