Skip to content

Commit

Permalink
update ReadMes, add storybook entry page for ai pkg
Browse files Browse the repository at this point in the history
  • Loading branch information
Lukas742 committed Feb 24, 2025
1 parent 9d8c501 commit bafd6ac
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .storybook/preview.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,8 @@ const preview: Preview = {
'Layouts & Floorplans',
'Modals & Popovers',
'User Feedback',
'AI',
['Docs'],
'Legacy Components'
]
}
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ You can find our documentation under the following links:

[![](https://badgen.net/npm/v/@ui5/webcomponents-cypress-commands?icon=npm)](https://www.npmjs.com/package/@ui5/webcomponents-cypress-commands)

- [@ui5/webcomponents-ai-react](https://github.com/SAP/ui5-webcomponents-react/tree/main/packages/ai) - React wrapper for the `@ui5/webcomponents-ai` Package

[![](https://badgen.net/npm/v/@ui5/webcomponents-ai-react?icon=npm)](https://www.npmjs.com/package/@ui5/webcomponents-ai-react)

<!-- *********************************************************************** -->

<a name="requirements"></a>
Expand Down
11 changes: 11 additions & 0 deletions docs/ReadMeAI.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Footer, TableOfContent } from '@sb/components';
import { Markdown, Meta } from '@storybook/blocks';
import ReadMe from '../packages/ai/README.md?raw';

<Meta title="AI / Docs" />

<TableOfContent />

<Markdown>{ReadMe.split('## Documentation')[0].trim()}</Markdown>

<Footer />
32 changes: 32 additions & 0 deletions packages/ai/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,35 @@
# @ui5/webcomponents-ai-react

React wrapper for the [@ui5/webcomponents-ai](https://sap.github.io/ui5-webcomponents/components/ai/) web components.

## Installation

To consume `@ui5/webcomponents-ai-react`, you need to install the npm modules and required peer dependencies:

```bash
npm install @ui5/webcomponents-ai-react @ui5/webcomponents-ai
```

## Provided assets

| Assets | Module | Notes |
| ---------------- | -------------------------------------- | ------------------------------------------------------ |
| `i18n`, `themes` | `@ui5/webcomponents-ai/dist/Assets.js` | Theming parameters and translations for the components |

## UI5 Web Components Documentation and Patterns

- Components: https://sap.github.io/ui5-webcomponents/components/ai/
- Patterns: https://sap.github.io/ui5-webcomponents/components/patterns/

## Documentation

You can find an interactive documentation in our [Storybook](https://sap.github.io/ui5-webcomponents-react/).

## Contribute

Please check our [Contribution Guidelines](https://github.com/SAP/ui5-webcomponents-react/blob/main/CONTRIBUTING.md).

## License

Please see our [LICENSE](https://github.com/SAP/ui5-webcomponents-react/blob/main/LICENSE) for copyright and license information.
Detailed information including third-party components and their licensing/copyright information is available via the [REUSE tool](https://api.reuse.software/info/github.com/SAP/ui5-webcomponents-react).

0 comments on commit bafd6ac

Please sign in to comment.