From b13a2952f741f3f5ce3137c672ac0a156b41c02b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bed=C5=99ich=20Schindler?= Date: Wed, 7 Oct 2026 09:44:57 +0200 Subject: [PATCH 1/2] Use relative links in docs and fix broken links (#650) --- .claude/rules/docs.md | 6 ++--- src/components/Alert/README.md | 10 ++++---- src/components/Badge/README.md | 8 +++---- src/components/Button/README.md | 32 ++++++++++++------------- src/components/ButtonGroup/README.md | 12 +++++----- src/components/Card/README.md | 12 +++++----- src/components/CheckboxField/README.md | 17 ++++++------- src/components/FileInputField/README.md | 10 ++++---- src/components/FormLayout/README.md | 20 ++++++++-------- src/components/Grid/README.md | 14 +++++------ src/components/InputGroup/README.md | 16 ++++++------- src/components/Modal/README.md | 20 ++++++++-------- src/components/Paper/README.md | 6 ++--- src/components/Popover/README.md | 6 ++--- src/components/Radio/README.md | 19 ++++++++------- src/components/ScrollView/README.md | 6 ++--- src/components/SelectField/README.md | 17 ++++++------- src/components/Table/README.md | 12 +++++----- src/components/Tabs/README.md | 4 ++-- src/components/Text/README.md | 6 ++--- src/components/TextArea/README.md | 8 +++---- src/components/TextField/README.md | 8 +++---- src/components/TextLink/README.md | 10 ++++---- src/components/Toggle/README.md | 17 ++++++------- src/components/Toolbar/README.md | 8 +++---- src/docs/contribute/api.md | 6 ++--- src/docs/contribute/composition.md | 2 +- src/docs/contribute/css.md | 6 ++--- src/docs/css-helpers/box-alignment.md | 6 ++--- src/docs/css-helpers/colors.md | 8 +++---- src/docs/css-helpers/display.md | 2 +- src/docs/css-helpers/spacing.md | 4 ++-- src/docs/customize/font.md | 2 +- src/docs/customize/theming/forms.md | 22 ++++++++--------- src/docs/customize/theming/overview.md | 4 ++-- src/docs/customize/translations.md | 4 ++-- src/docs/foundation/accessibility.md | 27 +++++++++++---------- src/docs/foundation/borders.md | 8 +++---- src/docs/foundation/colors.md | 30 ++++++++++++----------- src/docs/foundation/design-tokens.md | 2 +- src/docs/foundation/shadows.md | 8 +++---- src/docs/foundation/spacing.md | 5 ++-- src/docs/foundation/typography.md | 8 +++---- src/docs/getting-started/usage.md | 14 +++++------ src/index.md | 14 +++++------ 45 files changed, 247 insertions(+), 239 deletions(-) diff --git a/.claude/rules/docs.md b/.claude/rules/docs.md index 33cf24f02..ad4f73553 100644 --- a/.claude/rules/docs.md +++ b/.claude/rules/docs.md @@ -28,9 +28,9 @@ See [Commands](../../CLAUDE.md#commands). * Use relative links between docs. * Keep theming out of README prose: document it only in the `## Theming` section at the end of a component's `README.md`, including examples that override - `--rui-*` custom properties. Other sections must not link to - `/docs/customize/theming/*` or to `#theming` β€” downstream design systems drop - the whole section when they sync our docs. + `--rui-*` custom properties. Other sections must not link to the theming + guides (`docs/customize/theming/*.md`) or to `#theming` β€” downstream design + systems drop the whole section when they sync our docs. ## Reference diff --git a/src/components/Alert/README.md b/src/components/Alert/README.md index fa277a9d8..8bab92217 100644 --- a/src/components/Alert/README.md +++ b/src/components/Alert/README.md @@ -32,7 +32,7 @@ See [API](#api) for all available options. ## Color Variants To cover all possible needs of your project, Alert is available in colors from -[Feedback color collection](/docs/foundation/collections#colors). +[Feedback color collection](../../docs/foundation/collections.md#colors). ### Success @@ -116,7 +116,7 @@ Neutral informative alert. An icon can (and should) accompany the message. πŸ‘‰ Please note there are no icons pre-packed in React UI. Visit -[Icons](/docs/foundation/icons) to see how it works. +[Icons](../../docs/foundation/icons.md) to see how it works. ```docoff-react-preview }> @@ -159,8 +159,8 @@ React.createElement(() => { In addition to the options below in the [component's API](#api) section, you can specify **any HTML attribute you like.** All attributes that don't interfere with the API of the React component and that aren't filtered out by -[`transferProps`](/docs/js-helpers/transferProps) helper are forwarded to the -root `
` HTML element. This enables making the component interactive and +[`transferProps`](../../helpers/transferProps/README.md) helper are forwarded to +the root `
` HTML element. This enables making the component interactive and helps to improve its accessibility. πŸ‘‰ For the full list of supported attributes refer to: @@ -195,7 +195,7 @@ convention looks as follows: Where: - `` is a value from supported - [color collections](/docs/foundation/collections#colors) + [color collections](../../docs/foundation/collections.md#colors) (check [color variants](#color-variants) and [API](#api) to see which collections are supported), - `` is one of `color` (color of text), `foreground-color` (color of diff --git a/src/components/Badge/README.md b/src/components/Badge/README.md index fea6f3ad1..acda35c10 100644 --- a/src/components/Badge/README.md +++ b/src/components/Badge/README.md @@ -30,7 +30,7 @@ lowest: 2. outline All priorities are available in colors from supported -[color collections](/docs/foundation/collections#colors). +[color collections](../../docs/foundation/collections.md#colors). Check [API](#api) to see which collections are supported. ### Filled @@ -90,8 +90,8 @@ Medium-emphasis priority to provide additional context in an unobtrusive way. In addition to the options below in the [component's API](#api) section, you can specify **any HTML attribute you like.** All attributes that don't interfere with the API of the React component and that aren't filtered out by -[`transferProps`](/docs/js-helpers/transferProps) helper are forwarded to the -root `
` HTML element. This enables making the component interactive and +[`transferProps`](../../helpers/transferProps/README.md) helper are forwarded to +the root `
` HTML element. This enables making the component interactive and helps to improve its accessibility. πŸ‘‰ For the full list of supported attributes refer to: @@ -114,7 +114,7 @@ Where: - `` is one of `filled` or `outline`, - `` is a value from supported - [color collections](/docs/foundation/collections#colors) + [color collections](../../docs/foundation/collections.md#colors) (check [API](#api) to see which collections are supported), - `` is one of `color` (color of text) or `background-color` for the filled priority, or just `color` for the outline priority. diff --git a/src/components/Button/README.md b/src/components/Button/README.md index da2ca7d9d..b758d61b4 100644 --- a/src/components/Button/README.md +++ b/src/components/Button/README.md @@ -41,7 +41,7 @@ lowest: 3. flat All priorities are available in colors from supported -[color collections](/docs/foundation/collections#colors). +[color collections](../../docs/foundation/collections.md#colors). Check [API](#api) to see which collections are supported. ### Filled @@ -133,7 +133,7 @@ To improve clarity or to draw attention to the action, icons can be added before or after the button's label. πŸ‘‰ Please note there are no icons pre-packed in React UI. Visit -[Icons](/docs/foundation/icons) to see how to include them. +[Icons](../../docs/foundation/icons.md) to see how to include them. ```docoff-react-preview