feat(storybook): centralize doc in storybook only

Signed-off-by: aurore.stagnol <[email protected]>
ovh · Jul 29, 2024 · 4754ff5 · 4754ff5
1 parent 543eefe
commit 4754ff5
Show file tree

Hide file tree

Showing 43 changed files with 480 additions and 594 deletions.
diff --git a/packages/ods/scripts/generate-typedoc-md.js b/packages/ods/scripts/generate-typedoc-md.js
@@ -71,7 +71,7 @@ function convertJsonToMarkdown(jsonItems) {
 function createSpecMd(component = '') {
   const typedocJson = require(path.resolve(typedocBasePath, component, 'typedoc.json'));
   // TODO test for prefixed project (like -ovh)
-  const dir = path.resolve('documentation', 'specifications', component);
+  const dir = path.resolve('documentation');
 
   fs.mkdirSync(dir, { recursive: true });
 

diff --git a/packages/ods/src/components/icon/documentation/migration.from.17.x.mdx b/packages/ods/src/components/icon/documentation/migration.from.17.x.mdx
diff --git a/packages/ods/src/components/icon/documentation/overview-icon.mdx b/packages/ods/src/components/icon/documentation/overview-icon.mdx
diff --git a/packages/ods/src/components/icon/documentation/spec.md b/packages/ods/src/components/icon/documentation/spec.md
@@ -1,13 +1,26 @@
+<<<<<<< HEAD
 ## OdsIcon
 ### Properties
 | Property | Type | Required | Default value |
 | --- | --- | --- | --- |
 | alt | `string` | `false` | `''` |
 | name | `OdsIconName` | `true` | `undefined` |
+=======
+## Properties
+### alt
 
+• `Optional` **alt**: [_string_] = `''`
 
 
+### name
 
+•  **name**: [`arrow-left` | `warning`] 
+>>>>>>> 8dcddd22b (feat(storybook): centralize doc in storybook only)
+
+
+
+
+<<<<<<< HEAD
 ### Enums
 #### ODS_ICON_NAME
 
@@ -292,4 +305,12 @@
 • **user** = `"user"`
 
 • **xmark** = `"xmark"`
+=======
+## Enums
+### Enumeration: ODS_ICON_NAME
+
+• **arrowLeft** = `"arrow-left"`
+
+• **warning** = `"warning"`
+>>>>>>> 8dcddd22b (feat(storybook): centralize doc in storybook only)
 
diff --git a/packages/ods/src/components/icon/documentation/specifications/spec.md b/packages/ods/src/components/icon/documentation/specifications/spec.md
diff --git a/...ds/src/components/icon/documentation/usage-guidelines/properties/usage.name.mdx b/...ds/src/components/icon/documentation/usage-guidelines/properties/usage.name.mdx
diff --git a/packages/ods/src/components/icon/documentation/usage-guidelines/usage.mdx b/packages/ods/src/components/icon/documentation/usage-guidelines/usage.mdx
diff --git a/packages/ods/src/components/skeleton/documentation/migration.from.17.x.mdx b/packages/ods/src/components/skeleton/documentation/migration.from.17.x.mdx
diff --git a/packages/ods/src/components/skeleton/documentation/overview-skeleton.mdx b/packages/ods/src/components/skeleton/documentation/overview-skeleton.mdx
diff --git a/packages/ods/src/components/skeleton/documentation/spec.md b/packages/ods/src/components/skeleton/documentation/spec.md
@@ -1,2 +1,8 @@
+<<<<<<< HEAD
 ## OdsSkeleton
-This component has no properties, events nor methods.
+This component has no properties, events nor methods.
+=======
+
+
+
+>>>>>>> 8dcddd22b (feat(storybook): centralize doc in storybook only)
diff --git a/packages/ods/src/components/skeleton/documentation/specifications/spec.md b/packages/ods/src/components/skeleton/documentation/specifications/spec.md
diff --git a/...ages/ods/src/components/skeleton/documentation/style-customization-skeleton.mdx b/...ages/ods/src/components/skeleton/documentation/style-customization-skeleton.mdx
diff --git a/packages/ods/src/components/skeleton/documentation/usage-guidelines/usage.mdx b/packages/ods/src/components/skeleton/documentation/usage-guidelines/usage.mdx
diff --git a/packages/ods/src/components/spinner/documentation/migration.from.17.x.mdx b/packages/ods/src/components/spinner/documentation/migration.from.17.x.mdx
diff --git a/packages/ods/src/components/spinner/documentation/overview-spinner.mdx b/packages/ods/src/components/spinner/documentation/overview-spinner.mdx