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

Implement changes to formkit README doc structure #203

Merged
merged 2 commits into from
Jan 14, 2025
Merged
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
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@ The following sections are editable by making changes to the following files:

It is a monorepo that contains the following components:

- `@auro-formkit/auro-checkbox`
- `@auro-formkit/auro-combobox`
- `@auro-formkit/auro-counter`
- `@auro-formkit/auro-datepicker`
- `@auro-formkit/auro-dropdown`
- `@auro-formkit/auro-form`
- `@auro-formkit/auro-input`
- `@auro-formkit/auro-menu`
- `@auro-formkit/auro-radio`
- `@auro-formkit/auro-select`
- `auro-checkbox`
- `auro-combobox`
- `auro-counter`
- `auro-datepicker`
- `auro-dropdown`
- `auro-form`
- `auro-input`
- `auro-menu`
- `auro-radio`
- `auro-select`
<!-- AURO-GENERATED-CONTENT:END -->

## Install
Expand Down
44 changes: 18 additions & 26 deletions components/checkbox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ The README.md file is a compiled document. No edits should be made directly to t
README.md is created by running `npm run build:docs`.

This file is generated based on a template fetched from
`https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README_updated_paths.md`
and copied to `./componentDocs/README.md` each time the the docs are compiled.
`../../docs/templates/componentReadmeTemplate.md`
and copied to `./componentDocs/README.md` each time the docs are compiled.

The following sections are editable by making changes to the following files:

Expand All @@ -17,7 +17,7 @@ The following sections are editable by making changes to the following files:
| Component Example Code | HTML sample code of the components use | `./apiExamples/basic.html` |
-->

# Formkit/auro-checkbox
# Checkbox

<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
<!-- The below content is automatically added from ./docs/partials/description.md -->
Expand All @@ -37,18 +37,12 @@ For the most up to date information on [UI development browser support](https://

## Install

<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentInstall_esm.md) -->
[![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/-formkit/-formkit/auro-checkbox/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/-formkit/-formkit/auro-checkbox/actions/workflows/testPublish.yml)
[![See it on NPM!](https://img.shields.io/npm/v/@auro-formkit/-formkit/-formkit/auro-checkbox?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@auro-formkit/-formkit/-formkit/auro-checkbox)
[![License](https://img.shields.io/npm/l/@auro-formkit/-formkit/-formkit/auro-checkbox?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
![ESM supported](https://img.shields.io/badge/ESM-compatible-FFE900?style=for-the-badge)
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentInstall.md) -->
<!-- The below content is automatically added from ../../docs/templates/componentInstall.md -->

```shell
$ npm i @auro-formkit/-formkit/-formkit/auro-checkbox
$ npm i @aurodesignsystem/auro-formkit
```

Installing as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this [stack overflow](https://stackoverflow.com/questions/18875674/whats-the-difference-between-dependencies-devdependencies-and-peerdependencies) answer.

<!-- AURO-GENERATED-CONTENT:END -->

### Design Token CSS Custom Property dependency
Expand All @@ -61,17 +55,18 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
### Define dependency in project component

<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImportDescription.md) -->
Defining the component dependency within each component that is using the `<-formkit/-formkit/auro-checkbox>` component.
Defining the component dependency within each component that is using the `<auro-checkbox>` component.

<!-- AURO-GENERATED-CONTENT:END -->
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImport.md) -->
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentUsage.md) -->
<!-- The below content is automatically added from ../../docs/templates/componentUsage.md -->

```js
import "@auro-formkit/-formkit/-formkit/auro-checkbox";
import "@aurodesignsystem/auro-formkit/auro-checkbox";
```

<!-- AURO-GENERATED-CONTENT:END -->
**Reference component in HTML**

<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->

Expand All @@ -89,25 +84,22 @@ import "@auro-formkit/-formkit/-formkit/auro-checkbox";
## Install bundled assets from CDN

<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleInstallDescription.md) -->
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. See -- `-formkit/-formkit/auro-checkbox__bundled.js` for modern browsers. Legacy browsers such as IE11 are no longer supported.
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. See -- `auro-checkbox__bundled.js` for modern browsers. Legacy browsers such as IE11 are no longer supported.

**WARNING!** When installing into your application environment, DO NOT use `@latest` for the requested version. Risks include unknown MAJOR version releases and instant adoption of any new features and possible bugs without developer knowledge. The `@latest` wildcard should NEVER be used for production customer-facing applications. You have been warned.

<!-- AURO-GENERATED-CONTENT:END -->

### Bundle example code

<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleUseModBrowsers.md) -->

```html
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentBundleUseModBrowsers.md) -->
<!-- The below content is automatically added from ../../docs/templates/componentBundleUseModBrowsers.md -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/[email protected]/dist/tokens/CSSCustomProperties.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/[email protected]/dist/bundled/essentials.css" />
<script src="https://cdn.jsdelivr.net/npm/@auro-formkit/-formkit/-formkit/[email protected]/dist/-formkit/-formkit/auro-checkbox__bundled.js" type="module"></script>
```

<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit/[email protected]/dist/auro-checkbox__bundled.js" type="module"></script>
<!-- AURO-GENERATED-CONTENT:END -->

## auro-formkit/auro-checkbox use cases
## auro-checkbox use cases

<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
<!-- The below content is automatically added from ./docs/partials/useCases.md -->
Expand All @@ -119,7 +111,7 @@ The `<auro-checkbox>` element should be used in situations where users may:

## API Code Examples

### Default auro-formkit/auro-checkbox
### Default auro-checkbox

<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
Expand Down Expand Up @@ -175,7 +167,7 @@ The custom element API file is generated in the build and committed back to the
### Testing

<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/testing.md) -->
Automated tests are required for every Auro component. See `.\test\-formkit/-formkit/auro-checkbox.test.js` for the tests for this component. Run `npm test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details.
Automated tests are required for every Auro component. See `.\test\auro-checkbox.test.js` for the tests for this component. Run `npm test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details.

<!-- AURO-GENERATED-CONTENT:END -->

Expand Down
2 changes: 1 addition & 1 deletion components/checkbox/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@auro-formkit/auro-checkbox",
"name": "@aurodesignsystem/auro-checkbox",
"version": "4.1.0",
"description": "auro-checkbox HTML custom element",
"type": "module",
Expand Down
47 changes: 21 additions & 26 deletions components/combobox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ The README.md file is a compiled document. No edits should be made directly to t
README.md is created by running `npm run build:docs`.

This file is generated based on a template fetched from
`https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README_updated_paths.md`
and copied to `./componentDocs/README.md` each time the the docs are compiled.
`../../docs/templates/componentReadmeTemplate.md`
and copied to `./componentDocs/README.md` each time the docs are compiled.

The following sections are editable by making changes to the following files:

Expand All @@ -17,7 +17,7 @@ The following sections are editable by making changes to the following files:
| Component Example Code | HTML sample code of the components use | `./apiExamples/basic.html` |
-->

# Formkit/auro-combobox
# Combobox

<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
<!-- The below content is automatically added from ./docs/partials/description.md -->
Expand All @@ -37,18 +37,12 @@ For the most up to date information on [UI development browser support](https://

## Install

<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentInstall_esm.md) -->
[![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/-formkit/-formkit/auro-combobox/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/-formkit/-formkit/auro-combobox/actions/workflows/testPublish.yml)
[![See it on NPM!](https://img.shields.io/npm/v/@auro-formkit/-formkit/-formkit/auro-combobox?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@auro-formkit/-formkit/-formkit/auro-combobox)
[![License](https://img.shields.io/npm/l/@auro-formkit/-formkit/-formkit/auro-combobox?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
![ESM supported](https://img.shields.io/badge/ESM-compatible-FFE900?style=for-the-badge)
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentInstall.md) -->
<!-- The below content is automatically added from ../../docs/templates/componentInstall.md -->

```shell
$ npm i @auro-formkit/-formkit/-formkit/auro-combobox
$ npm i @aurodesignsystem/auro-formkit
```

Installing as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this [stack overflow](https://stackoverflow.com/questions/18875674/whats-the-difference-between-dependencies-devdependencies-and-peerdependencies) answer.

<!-- AURO-GENERATED-CONTENT:END -->

### Design Token CSS Custom Property dependency
Expand All @@ -61,17 +55,18 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
### Define dependency in project component

<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImportDescription.md) -->
Defining the component dependency within each component that is using the `<-formkit/-formkit/auro-combobox>` component.
Defining the component dependency within each component that is using the `<auro-combobox>` component.

<!-- AURO-GENERATED-CONTENT:END -->
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImport.md) -->
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentUsage.md) -->
<!-- The below content is automatically added from ../../docs/templates/componentUsage.md -->

```js
import "@auro-formkit/-formkit/-formkit/auro-combobox";
import "@aurodesignsystem/auro-formkit/auro-combobox";
```

<!-- AURO-GENERATED-CONTENT:END -->
**Reference component in HTML**

<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->

Expand All @@ -93,25 +88,25 @@ import "@auro-formkit/-formkit/-formkit/auro-combobox";
## Install bundled assets from CDN

<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleInstallDescription.md) -->
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. See -- `-formkit/-formkit/auro-combobox__bundled.js` for modern browsers. Legacy browsers such as IE11 are no longer supported.
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. See -- `auro-combobox__bundled.js` for modern browsers. Legacy browsers such as IE11 are no longer supported.

**WARNING!** When installing into your application environment, DO NOT use `@latest` for the requested version. Risks include unknown MAJOR version releases and instant adoption of any new features and possible bugs without developer knowledge. The `@latest` wildcard should NEVER be used for production customer-facing applications. You have been warned.

<!-- AURO-GENERATED-CONTENT:END -->

### Bundle example code

<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleUseModBrowsers.md) -->

```html
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentBundleUseModBrowsers.md) -->
<!-- The below content is automatically added from ../../docs/templates/componentBundleUseModBrowsers.md -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/[email protected]/dist/tokens/CSSCustomProperties.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/[email protected]/dist/bundled/essentials.css" />
<script src="https://cdn.jsdelivr.net/npm/@auro-formkit/-formkit/-formkit/[email protected]/dist/-formkit/-formkit/auro-combobox__bundled.js" type="module"></script>
```

<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit/[email protected]/dist/auro-dropdown__bundled.js" type="module"></script>
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit/[email protected]/dist/auro-input__bundled.js" type="module"></script>
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit/[email protected]/dist/auro-menu__bundled.js" type="module"></script>
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit/[email protected]/dist/auro-combobox__bundled.js" type="module"></script>
<!-- AURO-GENERATED-CONTENT:END -->

## auro-formkit/auro-combobox use cases
## auro-combobox use cases

<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
<!-- The below content is automatically added from ./docs/partials/useCases.md -->
Expand All @@ -128,7 +123,7 @@ The `<auro-combobox>` element should be used in situations where users may:

## API Code Examples

### Default auro-formkit/auro-combobox
### Default auro-combobox

<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
Expand Down Expand Up @@ -188,7 +183,7 @@ The custom element API file is generated in the build and committed back to the
### Testing

<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/testing.md) -->
Automated tests are required for every Auro component. See `.\test\-formkit/-formkit/auro-combobox.test.js` for the tests for this component. Run `npm test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details.
Automated tests are required for every Auro component. See `.\test\auro-combobox.test.js` for the tests for this component. Run `npm test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details.

<!-- AURO-GENERATED-CONTENT:END -->

Expand Down
10 changes: 5 additions & 5 deletions components/combobox/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@auro-formkit/auro-combobox",
"name": "@aurodesignsystem/auro-combobox",
"version": "2.1.4",
"description": "auro-combobox HTML custom element",
"type": "module",
Expand All @@ -16,7 +16,7 @@
"@auro-formkit/auro-dropdown": "*",
"@auro-formkit/auro-input": "*",
"@auro-formkit/auro-menu": "*",
"chalk": "^5.3.0",
"chalk": "^5.4.1",
"lit": "^3.2.1"
},
"peerDependencies": {
Expand All @@ -29,9 +29,9 @@
"@auro-formkit/form-validation": "*",
"@auro-formkit/typescript": "*",
"@aurodesignsystem/design-tokens": "^4.12.1",
"@aurodesignsystem/webcorestylesheets": "^5.1.2",
"@rollup/plugin-node-resolve": "^15.3.0",
"rollup": "^4.24.4",
"@aurodesignsystem/webcorestylesheets": "^6.0.0",
"@rollup/plugin-node-resolve": "^16.0.0",
"rollup": "^4.30.1",
"rollup-plugin-serve": "^2.0.3",
"wc-sass-render": "^1.4.0",
"web-component-analyzer": "^2.0.0"
Expand Down
2 changes: 1 addition & 1 deletion components/counter/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@auro-formkit/auro-counter",
"name": "@aurodesignsystem/auro-counter",
"version": "1.0.0",
"description": "auro-counter HTML custom element",
"repository": {
Expand Down
Loading
Loading