Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(web-core): update documentation structure #8135

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion @xen-orchestra/lite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@

## Guidelines

Please follow the guidelines from the `@xen-orchestra/web-core/docs/guidelines` directory.
Please follow the guidelines from [Web Core documentation](../web-core/docs/index.md)
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ If no style is applied to the root element, the class name will be omitted
```

> [!TIP]
> See also [Component variants guidelines](./component-variants.md)
> See also [Component variants guidelines](component-variants.md)
> to learn how to handle different component styles based on its props or states.

## Optional slots container SHOULD use `v-if="$slots.<slotName>"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A variant is a specific style that a component can have. It is usually determine
These variants are defined in the Design System and are reflected in the component's CSS.

See also:
[toVariants utility](../utils/to-variants.util.md) to help you generate variant CSS classes for your components.
[toVariants utility](../lib/utils/to-variants.util.md) to help you generate variant CSS classes for your components.

## Base class

Expand Down
158 changes: 0 additions & 158 deletions @xen-orchestra/web-core/docs/composables/context.composable.md

This file was deleted.

150 changes: 0 additions & 150 deletions @xen-orchestra/web-core/docs/contexts/color-context.md

This file was deleted.

24 changes: 24 additions & 0 deletions @xen-orchestra/web-core/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Guidelines

- [Component Definition](./component-definition.md)
- [Component Variants](./component-variants.md)
- [Internationalization (i18n)](./i18n.md)
- [Icons](./icons.md)
- [Stores](./stores.md)
- [Subscribable stores](./subscribable-stores.md)

# Composables

- [useItemCounter](../lib/composables/item-counter.composable.md)
- [useRouteQuery](../lib/composables/route-query.composable.md)
- [useTable](../lib/composables/table.composable.md)
- [useTree](../lib/composables/tree.composable.md)

# Directives

- [vTooltip](../lib/directives/tooltip.directive.md)

# Utils

- [isElse](../lib/utils/if-else.utils.md)
- [toVariants](../lib/utils/to-variants.util.md)
2 changes: 1 addition & 1 deletion @xen-orchestra/web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@

## Guidelines

Please follow the guidelines from the `@xen-orchestra/web-core/docs/guidelines` directory.
Please follow the guidelines from [Web Core documentation](../web-core/docs/index.md)
Loading