-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
perf: add dynamic documentation for monorepo structure #150
- Loading branch information
1 parent
e61f3e5
commit cad9ef2
Showing
28 changed files
with
358 additions
and
317 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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: | ||
|
|
@@ -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 --> | ||
|
|
@@ -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) --> | ||
| [](https://github.com/AlaskaAirlines/-formkit/-formkit/auro-checkbox/actions/workflows/testPublish.yml) | ||
| [](https://www.npmjs.com/package/@auro-formkit/-formkit/-formkit/auro-checkbox) | ||
| [](https://www.apache.org/licenses/LICENSE-2.0) | ||
|  | ||
| <!-- 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 | ||
|
|
@@ -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 --> | ||
|
|
||
|
|
@@ -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 --> | ||
|
|
@@ -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 --> | ||
|
|
@@ -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 --> | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,7 @@ 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` | ||
| `../../docs/templates/componentReadmeTemplate.md` | ||
| and copied to `./componentDocs/README.md` each time the the docs are compiled. | ||
| The following sections are editable by making changes to the following files: | ||
|
|
@@ -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 --> | ||
|
|
@@ -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) --> | ||
| [](https://github.com/AlaskaAirlines/-formkit/-formkit/auro-combobox/actions/workflows/testPublish.yml) | ||
| [](https://www.npmjs.com/package/@auro-formkit/-formkit/-formkit/auro-combobox) | ||
| [](https://www.apache.org/licenses/LICENSE-2.0) | ||
|  | ||
| <!-- 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 | ||
|
|
@@ -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 --> | ||
|
|
||
|
|
@@ -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 --> | ||
|
|
@@ -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 --> | ||
|
|
@@ -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 --> | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.