docs(web-core): update documentation structure

vatesfr · Nov 14, 2024 · 81a7cb3 · 81a7cb3
1 parent 224c09e
commit 81a7cb3
Show file tree

Hide file tree

Showing 14 changed files with 26 additions and 310 deletions.
diff --git a/...e/docs/guidelines/component-definition.md → ...tra/web-core/docs/component-definition.md b/...e/docs/guidelines/component-definition.md → ...tra/web-core/docs/component-definition.md
@@ -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>"`

diff --git a/...ore/docs/guidelines/component-variants.md → ...estra/web-core/docs/component-variants.md b/...ore/docs/guidelines/component-variants.md → ...estra/web-core/docs/component-variants.md
@@ -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
 

diff --git a/@xen-orchestra/web-core/docs/composables/context.composable.md b/@xen-orchestra/web-core/docs/composables/context.composable.md
diff --git a/@xen-orchestra/web-core/docs/contexts/color-context.md b/@xen-orchestra/web-core/docs/contexts/color-context.md
diff --git a/...rchestra/web-core/docs/guidelines/i18n.md → @xen-orchestra/web-core/docs/i18n.md b/...rchestra/web-core/docs/guidelines/i18n.md → @xen-orchestra/web-core/docs/i18n.md
diff --git a/...chestra/web-core/docs/guidelines/icons.md → @xen-orchestra/web-core/docs/icons.md b/...chestra/web-core/docs/guidelines/icons.md → @xen-orchestra/web-core/docs/icons.md
diff --git a/@xen-orchestra/web-core/docs/index.md b/@xen-orchestra/web-core/docs/index.md
@@ -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)
diff --git a/...hestra/web-core/docs/guidelines/stores.md → @xen-orchestra/web-core/docs/stores.md b/...hestra/web-core/docs/guidelines/stores.md → @xen-orchestra/web-core/docs/stores.md
diff --git a/...b-core/docs/stores/subscribable-stores.md → ...stra/web-core/docs/subscribable-stores.md b/...b-core/docs/stores/subscribable-stores.md → ...stra/web-core/docs/subscribable-stores.md
diff --git a/...ocs/composables/route-query.composable.md → ...lib/composables/route-query.composable.md b/...ocs/composables/route-query.composable.md → ...lib/composables/route-query.composable.md
diff --git a/...core/docs/composables/table.composable.md → ...-core/lib/composables/table.composable.md b/...core/docs/composables/table.composable.md → ...-core/lib/composables/table.composable.md
diff --git a/...-core/docs/composables/tree.composable.md → ...b-core/lib/composables/tree.composable.md b/...-core/docs/composables/tree.composable.md → ...b-core/lib/composables/tree.composable.md
diff --git a/...stra/web-core/docs/utils/if-else.utils.md → ...estra/web-core/lib/utils/if-else.utils.md b/...stra/web-core/docs/utils/if-else.utils.md → ...estra/web-core/lib/utils/if-else.utils.md
diff --git a/...a/web-core/docs/utils/to-variants.util.md → ...ra/web-core/lib/utils/to-variants.util.md b/...a/web-core/docs/utils/to-variants.util.md → ...ra/web-core/lib/utils/to-variants.util.md