Skip to content

Commit

Permalink
Fix broken links and typos in documentation. (#235)
Browse files Browse the repository at this point in the history
* Fix links in docs with updated page locations.

* Fix more links and typos.

* Fix article for FCalendarController.
  • Loading branch information
andeart authored Oct 21, 2024
1 parent 7dc871a commit 5698efe
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/pages/docs/data/icon.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import LinkBadge from "../../../components/link-badge/link-badge.tsx";
import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx";

# Icon
An icon that inherits its style from an enclosing, supported widget, such as a [button](/docs/button).
An icon that inherits its style from an enclosing, supported widget, such as a [button](/docs/form/button).

<LinkBadgeGroup>
<LinkBadge label="API Reference" href="https://pub.dev/documentation/forui/latest/forui.widgets.icon/forui.widgets.icon-library.html"/>
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/form/calendar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A date field component that allows users to enter and edit date.
The calendar pages are designed to be navigable through swipe gestures on mobile platforms, allowing left and right
swipes to transition between pages.

A [`FCalendarController`](https://pub.dev/documentation/forui/latest/forui.widgets/FCalendarController-class.html) is used
An [`FCalendarController`](https://pub.dev/documentation/forui/latest/forui.widgets.calendar/FCalendarController-class.html) is used
to customize the date selection behavior.

<LinkBadgeGroup>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/docs/form/checkbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"
# Checkbox
A control that allows the user to toggle between checked and not checked.

For touch devices, a [switch](/docs/switch) is generally recommended over a checkbox.
For touch devices, a [switch](/docs/form/switch) is generally recommended over a checkbox.

<LinkBadgeGroup>
<LinkBadge label="API Reference" href="https://pub.dev/documentation/forui/latest/forui.widgets.checkbox/forui.widgets.checkbox-library.html"/>
</LinkBadgeGroup>

<div className="pb-5">
<Callout type="info">
We recommend using a [select group](/docs/select-group#checkbox-form) to create a group of checkboxes.
We recommend using a [select group](/docs/form/select-group#checkbox-form) to create a group of checkboxes.
</Callout>
</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/form/radio.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A radio button that typically allows the user to choose only one of a predefined

<div className="pb-5">
<Callout type="info">
We recommend using a [select group](/docs/select-group#radio-form) to create a group of radio buttons instead of using `FRadio` directly.
We recommend using a [select group](/docs/form/select-group#radio-form) to create a group of radio buttons instead of using `FRadio` directly.
</Callout>
</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/icon-library.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ flutter pub install forui_assets
</Callout>

<Callout type="info">
While you can use an icon from `forui_assets` directly, it is recommended to wrap it in an [FIcon](/docs/icon) to
While you can use an icon from `forui_assets` directly, it is recommended to wrap it in an [FIcon](/docs/data/icon) to
automatically configure its color and size.
</Callout>

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ flutter pub add forui_assets

To use Forui widgets in your Flutter app, import the Forui package and place the
[`FTheme`](https://pub.dev/documentation/forui/latest/forui.theme/FTheme-class.html) widget underneath `CupertinoApp`,
`MaterialApp`, or `WidgetsApp` at at the root of the widget tree.
`MaterialApp`, or `WidgetsApp` at the root of the widget tree.

```dart filename="main.dart" {3,12-18}
import 'package:flutter/material.dart';
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/navigation/bottom-navigation-bar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ It is used to navigate between a small number of views, typically between three
## Usage

<Callout type="info">
A bottom navigation bar is typically used with `FScaffold`. A working example can be found [here](/docs/scaffold).
A bottom navigation bar is typically used with `FScaffold`. A working example can be found [here](/docs/layout/scaffold).
</Callout>

### `FBottomNavigationBar(...)`
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/navigation/header.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ It is typically used on nested pages or sheets.
## Usage

<Callout type="info">
A header is typically used with `FScaffold`. A working example can be found [here](/docs/scaffold).
A header is typically used with `FScaffold`. A working example can be found [here](/docs/layout/scaffold).
</Callout>

### `FHeader(...)`
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/themes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ A more detailed explanation of each class can be found in the [Class Diagram](#c
## Customize Themes

It's recommended to use the predefined themes as a starting point and customize them with the
[`inhert(...)`](https://pub.dev/documentation/forui/latest/forui.theme/FThemeData/FThemeData.inherit.html) constructor
[`inherit(...)`](https://pub.dev/documentation/forui/latest/forui.theme/FThemeData/FThemeData.inherit.html) constructor
and [`copyWith(...)`](https://pub.dev/documentation/forui/latest/forui.theme/FThemeData/copyWith.html) method to suit your needs.

```dart filename="main.dart" {3-14, 17-23}
Expand Down

0 comments on commit 5698efe

Please sign in to comment.