feat: Better doc generation (#143)

lenra-io · Feb 16, 2023 · 1cb8968 · 1cb8968
1 parent a8750d4
commit 1cb8968
Show file tree

Hide file tree

Showing 103 changed files with 1,681 additions and 3,464 deletions.
diff --git a/.github/workflows/build_doc_test.yml b/.github/workflows/build_doc_test.yml
@@ -0,0 +1,23 @@
+name: Build doc CI
+on:
+ pull_request:
+ types:
+ - opened
+ - edited
+ - synchronize
+
+jobs:
+ test:
+ runs-on: ubuntu-22.04
+ defaults:
+ run:
+ working-directory: ./docs
+ steps:
+ - uses: actions/checkout@v3
+ with:
+ submodules: true
+ - uses: actions/setup-node@v3
+ with:
+ node-version: 18
+ - run: npm i
+ - run: npm run build
diff --git a/api/component.schema.json b/api/component.schema.json
@@ -2,7 +2,7 @@
  "$schema": "https://raw.githubusercontent.com/lenra-io/ex_component_schema/beta/priv/static/draft-lenra.json",
  "$id": "component.schema.json",
  "title": "Component",
- "description": "The component abstract type",
+ "description": "Any component",
  "oneOf": [
  {
  "$ref": "components/actionable.schema.json"

diff --git a/api/components/button.schema.json b/api/components/button.schema.json
@@ -30,10 +30,10 @@
  "$ref": "../defs/listener.schema.json"
  },
  "leftIcon": {
- "$ref": "icon.schema.json"
+ "$ref": "../components/icon.schema.json"
  },
  "rightIcon": {
- "$ref": "icon.schema.json"
+ "$ref": "../components/icon.schema.json"
  },
  "submit": {
  "description": "Whether the button is a submit button for a form.",

diff --git a/api/components/dropdownButton.schema.json b/api/components/dropdownButton.schema.json
@@ -30,7 +30,7 @@
  "$ref": "../component.schema.json"
  },
  "icon": {
- "$ref": "icon.schema.json"
+ "$ref": "../components/icon.schema.json"
  }
  },
  "required": [

diff --git a/api/components/icon.schema.json b/api/components/icon.schema.json
@@ -33,7 +33,23 @@
  },
  "value": {
  "description": "The value of the Icon",
- "$ref": "../defs/iconData.schema.json"
+ "$ref": "../defs/iconName.schema.json"
+ },
+ "style": {
+ "$ref": "#/definitions/iconStyle"
+ }
+ },
+ "definitions": {
+ "iconStyle": {
+ "type": "string",
+ "description": "The style of the Icon",
+ "enum": [
+ "filled",
+ "sharp",
+ "rounded",
+ "outlined"
+ ],
+ "default": "filled"
  }
  }
 }
diff --git a/api/components/menuItem.schema.json b/api/components/menuItem.schema.json
@@ -26,7 +26,7 @@
  "default": false
  },
  "icon": {
- "$ref": "icon.schema.json"
+ "$ref": "../components/icon.schema.json"
  },
  "onPressed": {
  "$ref": "../defs/listener.schema.json"

diff --git a/api/defs/action.schema.json b/api/defs/action.schema.json
diff --git a/api/defs/flexFit.schema.json b/api/defs/flexFit.schema.json
@@ -1,7 +1,7 @@
 {
  "$schema": "https://raw.githubusercontent.com/lenra-io/ex_component_schema/beta/priv/static/draft-lenra.json",
  "$id": "defs/flexFit.schema.json",
- "title": "flexFit",
+ "title": "FlexFit",
  "description": "How a flexible child is inscribed into the available space.",
  "type": "string",
  "enum": [