Skip to content

Commit

Permalink
docs:rename ui to design o match developer portal
Browse files Browse the repository at this point in the history
  • Loading branch information
Topener committed Oct 29, 2024
1 parent 9e600d9 commit fec30fb
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/docs/components/alertbar.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,12 +154,12 @@ Read more about the `useAlert()` hook at the [App Runtime documentation](https:/

- Alert bar labels should be clear, concise, and easy to understand. Remember, `info` and `success` alert bars dismiss automatically.
- Don't use unclear labels like _Success_, _Failed_, or vague descriptions like _There was a problem_. Be clear and precise.
- Check the [A-Z glossary](/ui/patterns/glossary) and [communication guidelines](/ui/principles/content-communication) for more tips for writing useful labels.
- Check the [A-Z glossary](/design/patterns/glossary) and [communication guidelines](/design/principles/content-communication) for more tips for writing useful labels.

#### Display

- Several alert bars can be shown at the same time.
- Alert bars are automatically shown in the correct size and spacings when using an [`AlertStack`](https://ui.dhis2.nu/demo/?path=/story/feedback-alerts-alert-stack--default).
- Alert bars are automatically shown in the correct size and spacings when using an [`AlertStack`](pathname:///demo/?path=/story/feedback-alerts-alert-stack--default).

## Options

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/calendar.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Calendar is a component to display a calendar to pick a day in multiple cale

The component is built on top of [multi-calendar-dates](https://github.com/dhis2/multi-calendar-dates/tree/beta) which is an internal library to abstract date-related operations (i.e. calendars, period selectors, date math etc..). The library itself relies on the [Temporal proposal](https://tc39.es/proposal-temporal/#sec-temporal-intro). The proposal (currently at Stage 3 draft) aims to improve built-in support for dates and times in browsers, addressing challenges such as support for timezones, DST-safe artithemtic, string serialization and interoperability via standardized formats, and full support for non-Gregorian calendars.

Here are some sample calendars built with this UI component. Check [StoryBook](https://ui.dhis2.nu/demo/?path=/story/calendar--with-ethiopic) to play with all the options available for building a Calendar.
Here are some sample calendars built with this UI component. Check [StoryBook](pathname:///demo/?path=/story/calendar--with-ethiopic) to play with all the options available for building a Calendar.

## Ethiopic calendar

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/components/inputfield.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,12 @@ Inputs width should reflect the expected content.
```

- Use a `Textarea` if more than a single sentence of content is expected.
- [`Textarea`](https://ui.dhis2.nu/demo/?path=/story/forms-text-area-text-area-field--no-placeholder-no-value) is available as a standalone component.
- [`Textarea`](pathname:///demo/?path=/story/forms-text-area-text-area-field--no-placeholder-no-value) is available as a standalone component.

### Validation

- Validating the type of data entered isn't part of the components themselves.
- Read more about [form handling in DHIS2](/ui/utilities/forms/react-final-form).
- Read more about [form handling in DHIS2](/design/utilities/forms/react-final-form).

### Read-only

Expand Down Expand Up @@ -174,7 +174,7 @@ Inputs width should reflect the expected content.

- Use an error state if there's a problem with the content of the input, or if it's required but empty.
- Don't show an error too early, give the user a chance to finish entering data.
- The error text should help the user fix the problem. Refer to the [error writing guidelines](/ui/principles/content-communication) for examples.
- The error text should help the user fix the problem. Refer to the [error writing guidelines](/design/principles/content-communication) for examples.

### State: Disabled

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ A menu gives access to menu items, through a panel that opens from a trigger ele

- Menu item labels should be short and easy to understand.
- One or two words is often enough to explain the action.
- Refer to the [writing guidelines](/ui/patterns/writing) and [glossary](/ui/patterns/glossary) for more information about writing useful labels.
- Refer to the [writing guidelines](/design/patterns/writing) and [glossary](/design/patterns/glossary) for more information about writing useful labels.

##### Order and grouping

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/notice-box.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ A notice box shows important information about a situation.

- Notice box titles should be a short summary to help the user scan elements the page.
- Notice box text should be clear and informative. Explain what the situation is and, if relevant, offer a solution.
- Check the [writing guidelines](/ui/patterns/writing) for more information.
- Check the [writing guidelines](/design/patterns/writing) for more information.

## Options

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/popover.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ A popover is used to show more information when a user interacts with a trigger
### Format

- A popover doesn't offer any default content styling.
- Include padding between the popover frame and the content inside. The amount of padding depends on the content and density of the interface. Use a [spacer constant](/ui/utilities/constants) for a consistent visual experience.
- Include padding between the popover frame and the content inside. The amount of padding depends on the content and density of the interface. Use a [spacer constant](/design/utilities/constants) for a consistent visual experience.

## API Reference

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/select.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ Selects are used to choose one or more items from a list of options.

- Use an error state if there's a problem with the chosen option, or if it's required but empty.
- Don't show an error too early, give the user a chance to make a choice.
- The error text should help the user fix the problem. Refer to the [error writing guidelines](/ui/principles/content-communication) for examples.
- The error text should help the user fix the problem. Refer to the [error writing guidelines](/design/principles/content-communication) for examples.

### State: Disabled

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/help/migrating.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Migrating from < v5

A number of important changes were introduced in UI version 5.0.0. To see more about these changes and how to migrate from older versions, see [this blog post](https://developers.dhis2.org/blog/ui-5-release) at the developer portal.
A number of important changes were introduced in UI version 5.0.0. To see more about these changes and how to migrate from older versions, see [this blog post](/blog/ui-5-release) at the developer portal.

## Migrating from < v6

Expand Down

0 comments on commit fec30fb

Please sign in to comment.