Skip to content

Commit

Permalink
website: add metadata placeholders
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Nov 21, 2024
1 parent 1b105ea commit 767353e
Show file tree
Hide file tree
Showing 4 changed files with 191 additions and 3 deletions.
72 changes: 72 additions & 0 deletions website/docs/user/metadata/cdlComponents/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---

title: xCDL Components Definitions
description: The members of the xCDL components
keywords:
- xpack
- xcdl
- cdl
- component

date: 2024-11-21 11:58:00 +0300

---

# xCDL Components Definitions

:::note

Work in progress.

:::

The `cdlComponents` are maps of component definitions.

## Component name

Component names are dash separated lower case words, preferably ASCII only.

Examples:

- `utils-lists`
- `micro-test-plus`

## Component members

The components objects have the following members:

### `description`

TBD

### `parent`

TBD

### `compilerIncludeFolders`

TBD

### `compilerSourceFiles`

TBD

### `compilerDefinitions`

TBD

### `compilerOptions`

TBD

### `dependencies`

TBD

### `generatedDefinition`

TBD

### `cdlOptions`

TBD
40 changes: 40 additions & 0 deletions website/docs/user/metadata/cdlOptions/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---

title: xCDL Options Definitions
description: The members of the xCDL options
keywords:
- xpack
- xcdl
- cdl
- option

date: 2024-11-21 11:59:00 +0300

---

# xCDL Options Definitions

:::note

Work in progress.

:::

The `cdlOptions` are maps of option definitions.

## Option name

Component names are dash separated lower case words, preferably ASCII only.

Examples:

- `trace-utils-lists`

## Option members

The options objects has the following members:

### `generatedDefinition`

TBD

46 changes: 46 additions & 0 deletions website/docs/user/metadata/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---

title: xCDL Metadata
description: The members of the xCDL components
keywords:
- xpack
- xcdl
- cdl
- component

date: 2024-11-21 11:58:00 +0300

---

# xCDL Metadata

:::note

Work in progress.

:::

The xCDL metadata is a set of definitions used by `xcdl` to drive the
configuration process.

These definitions are stored in `package.json`, in the `xpack` object.

## `minimumXcdlRequired`

A string with a SemVer.

Defines the minimum version of `xcdl` that can process the xCDL definitions.

## `license`

TBD

## `copyright`

TBD

## `cdlComponents`

TBD


36 changes: 33 additions & 3 deletions website/sidebar-docs-custom.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,39 @@ export const customDocsSidebar = [
label: 'Install Guide'
},
{
type: 'doc',
id: 'user/index',
label: 'User Information'
type: 'category',
label: 'User Information',
link: {
type: 'doc',
id: 'user/index',
},
"items": [
{
type: 'doc',
id: 'user/index',
label: 'Overview'
},
{
type: 'category',
label: 'Metadata',
link: {
type: 'doc',
id: 'user/metadata/index',
},
"items": [
{
type: 'doc',
id: 'user/metadata/cdlComponents/index',
label: 'cdlComponents'
},
{
type: 'doc',
id: 'user/metadata/cdlOptions/index',
label: 'cdlOptions'
},
]
}
]
},
{
type: 'doc',
Expand Down

0 comments on commit 767353e

Please sign in to comment.