Rename demo files

[jordanjones243]

Rename demo files from demo.md to index.md and apiExamples.md to api.md. This change is requested to give a consistent naming convention for all files that refer to the component landing page and api example page.

[blackfalcon]

Here is an audit of the different repos and if/and how they are supporting automated document building.

Repo	Supports MarkdownMagic	demo.md	index.md	comments
Accordion			√
Alert	no		√
Avatar	no		√
Background			√
Back to Top			√
Badge	no		√
Banner			√
Button			√
Card			√
Carousel			√
Checkbox			√
Combobox			√
Datetime	no		√
Datepicker			√
Dialog			√
Drawer			√
Dropdown			√
Flight			√
Flightline	no		√
Header	no		√
Hyperlink			√
Icon	no		√
Input			√
Loader			√
Lockup			√
Menu			√
Nav			√
Pane			√
Popover			√
Radio			√
Select			√
Skeleton			√
Sidenav			√
Table		√		See ref to demo.md
Toast			√

[blackfalcon]

All repos except auro-table validated for correct configuration.

[blackfalcon]

Recently there was a release of the Auro Generator that changed the endpoint of the API documentation for a repo to be from ./apiExamples.md to ./api.md.

We currently do not have a plan for updating all the repos to be in sync with this change. Repos were already in a confusing state with incomplete moving to the ./apiExamples.md endpoint started 3 years ago. Moving this back, I would prefer that we get all the repos on the same page sooner rather than later to reduce any confusion.

Please see the attached documents that represent the number of repos that are either supporting ./api.md versus ./apiExamples.md endpoints.

apiExamplesmd_references.md
apimd_references.md

[jason-capsule42]

All of this work was done as part of the recent push to update the docsite.

All repos are already updated to use the new standard.

[blackfalcon]

Here is a search result that still has a lot of references to apiExamples.md

https://github.com/search?q=org%3AAlaskaAirlines+demo%2FapiExamples.md&type=code&p=1

background/package.json
118:            "./demo/apiExamples.md"

background/scripts/generateDocs.mjs
94:  fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
95:    formatTemplateFileContents(data, './demo/apiExamples.md');
151: * Compiles `./docTemplates/apiExamples.md` -> `./demo/apiExamples.md`
156:    if (fs.existsSync('./demo/apiExamples.md')) {
157:      fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
158:        formatApiTableContents(data, './demo/apiExamples.md');
161:      console.log('ERROR: ./demo/apiExamples.md file is missing');
170:  const markdownPath = path.join(__dirname, '../docs/partials/apiExamples.md');

pane/package.json
119:            "./demo/apiExamples.md"

drawer/package.json
119:            "./demo/apiExamples.md"

hyperlink/package.json
122:            "./demo/apiExamples.md"

radio/demo/api.html
6:  All demo code should be added/edited in ./demo/apiExamples.md

radio/package.json
121:            "./demo/apiExamples.md"

card/package.json
122:            "./demo/apiExamples.md"

// this is in the current main branch
card/scripts/generateDocs.mjs
94:  fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
95:    formatTemplateFileContents(data, './demo/apiExamples.md');
151: * Compiles `./docTemplates/apiExamples.md` -> `./demo/apiExamples.md`
156:    if (fs.existsSync('./demo/apiExamples.md')) {
157:      fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
158:        formatApiTableContents(data, './demo/apiExamples.md');
161:      console.log('ERROR: ./demo/apiExamples.md file is missing');
170:  const markdownPath = path.join(__dirname, '../docs/partials/apiExamples.md');

// This is the new total refactor branch #44
auro-card/demo/api.html
6:  All demo code should be added/edited in ./demo/apiExamples.md
35:      fetch('/demo/apiExamples.md')

// This is the new total refactor branch #44
auro-card/package.json
118:            "./demo/apiExamples.md"

// This is the new total refactor branch #44
auro-card/scripts/generateDocs.mjs
94:  fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
95:    formatTemplateFileContents(data, './demo/apiExamples.md');
151: * Compiles `./docTemplates/apiExamples.md` -> `./demo/apiExamples.md`
156:    if (fs.existsSync('./demo/apiExamples.md')) {
157:      fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
158:        formatApiTableContents(data, './demo/apiExamples.md');
161:      console.log('ERROR: ./demo/apiExamples.md file is missing');
170:  const markdownPath = path.join(__dirname, '../docs/partials/apiExamples.md');

AuroDocsSite/src/content/dynamic/badge/api.js
8:    this.markdownContentPath = 'demo/apiExamples.md';

input/package.json
126:            "./demo/apiExamples.md"

datepicker/package.json
125:            "./demo/apiExamples.md"

datepicker/scripts/generateDocs.mjs
94:  fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
95:    formatTemplateFileContents(data, './demo/apiExamples.md');
151: * Compiles `./docTemplates/apiExamples.md` -> `./demo/apiExamples.md`
156:    if (fs.existsSync('./demo/apiExamples.md')) {
157:      fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
158:        formatApiTableContents(data, './demo/apiExamples.md');
161:      console.log('ERROR: ./demo/apiExamples.md file is missing');
170:  const markdownPath = path.join(__dirname, '../docs/partials/apiExamples.md');

checkbox/demo/api.html
6:  All demo code should be added/edited in ./demo/apiExamples.md

checkbox/package.json
118:            "./demo/apiExamples.md"

library/bin/generateDocs.mjs
94:  fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
95:    formatTemplateFileContents(data, './demo/apiExamples.md');
151: * Compiles `./docTemplates/apiExamples.md` -> `./demo/apiExamples.md`
156:    if (fs.existsSync('./demo/apiExamples.md')) {
157:      fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
158:        formatApiTableContents(data, './demo/apiExamples.md');
161:      console.log('ERROR: ./demo/apiExamples.md file is missing');
170:  const markdownPath = path.join(__dirname, '../docs/partials/apiExamples.md');

library/bin/generateDocs_index.mjs
94:  fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
95:    formatTemplateFileContents(data, './demo/apiExamples.md');
151: * Compiles `./docTemplates/apiExamples.md` -> `./demo/apiExamples.md`
156:    if (fs.existsSync('./demo/apiExamples.md')) {
157:      fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
158:        formatApiTableContents(data, './demo/apiExamples.md');
161:      console.log('ERROR: ./demo/apiExamples.md file is missing');
170:  const markdownPath = path.join(__dirname, '../docs/partials/apiExamples.md');

combobox/package.json
117:            "./demo/apiExamples.md"

dialog/package.json
120:            "./demo/apiExamples.md"

popover/package.json
119:            "./demo/apiExamples.md"

table/demo/api.html
6:  All demo code should be added/edited in ./demo/apiExamples.md

table/package.json
118:            "./demo/apiExamples.md"

menu/demo/api.html
6:  All demo code should be added/edited in ./demo/apiExamples.md

menu/package.json
121:            "./demo/apiExamples.md"

select/demo/api.md
2:The apiExamples.md file is a compiled document. No edits should be made directly to this file.
4:apiExamples.md is created by running `npm run build:markdownDocs`.
6:This file is generated based on a template fetched from `./docs/partials/apiExamples.md`

select/demo/api.html
6:  All demo code should be added/edited in ./demo/apiExamples.md

select/docs/partials/api.md
2:The apiExamples.md file is a compiled document. No edits should be made directly to this file.
4:apiExamples.md is created by running `npm run build:markdownDocs`.
6:This file is generated based on a template fetched from `./docs/partials/apiExamples.md`

select/package.json
118:            "./demo/apiExamples.md"

select/scripts/generateDocs.mjs
94:  fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
95:    formatTemplateFileContents(data, './demo/apiExamples.md');
151: * Compiles `./docTemplates/apiExamples.md` -> `./demo/apiExamples.md`
156:    if (fs.existsSync('./demo/apiExamples.md')) {
157:      fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
158:        formatApiTableContents(data, './demo/apiExamples.md');
161:      console.log('ERROR: ./demo/apiExamples.md file is missing');
170:  const markdownPath = path.join(__dirname, '../docs/partials/apiExamples.md');

nav/package.json
123:            "./demo/apiExamples.md"

banner/package.json
119:            "./demo/apiExamples.md"

banner/scripts/generateDocs.mjs
94:  fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
95:    formatTemplateFileContents(data, './demo/apiExamples.md');
151: * Compiles `./docTemplates/apiExamples.md` -> `./demo/apiExamples.md`
156:    if (fs.existsSync('./demo/apiExamples.md')) {
157:      fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
158:        formatApiTableContents(data, './demo/apiExamples.md');
161:      console.log('ERROR: ./demo/apiExamples.md file is missing');
170:  const markdownPath = path.join(__dirname, '../docs/partials/apiExamples.md');

badge/demo/api.html
35:      fetch('/demo/apiExamples.md')

badge/package.json
140:            "./demo/apiExamples.md"

badge/scripts/generateDocs.mjs
94:  fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
95:    formatTemplateFileContents(data, './demo/apiExamples.md');
151: * Compiles `./docTemplates/apiExamples.md` -> `./demo/apiExamples.md`
156:    if (fs.existsSync('./demo/apiExamples.md')) {
157:      fs.readFile('./demo/apiExamples.md', 'utf8', function(err, data) {
158:        formatApiTableContents(data, './demo/apiExamples.md');
161:      console.log('ERROR: ./demo/apiExamples.md file is missing');
170:  const markdownPath = path.join(__dirname, '../docs/partials/apiExamples.md');

[blackfalcon]

This is a list of repos that are still referencing demo/demo.md versus demo/index.md

https://github.com/search?q=org%3AAlaskaAirlines+demo%2Fdemo.md&type=code

background/package.json
117:            "./demo/demo.md",

pane/package.json
118:            "./demo/demo.md",

drawer/package.json
118:            "./demo/demo.md",

hyperlink/package.json
121:            "./demo/demo.md",

radio/demo/index.html
6:  All demo code should be added/edited in ./demo/demo.md

radio/package.json
120:            "./demo/demo.md",

card/package.json
121:            "./demo/demo.md",

auro-card/package.json
117:            "./demo/demo.md",

AuroDocsSite/src/content/dynamic/_template/component.js
6:// import markdownContent from '@alaskaairux/auro-[component]/demo/demo.md'
9:const markdownContent = 'https://raw.githubusercontent.com/AlaskaAirlines/auro-[component]/master/demo/demo.md';

AuroDocsSite/src/content/dynamic/contributing/dod.js
6:// import markdownContent from '@alaskaairux/auro-[component]/demo/demo.md'

AuroDocsSite/src/content/dynamic/contributing/contributing.js
6:// import markdownContent from '@alaskaairux/auro-[component]/demo/demo.md'

AuroDocsSite/src/content/dynamic/table/component.js
8:    this.markdownContentPath = 'demo/demo.md';

AuroDocsSite/src/content/dynamic/tokenlist/component.js
6:// import markdownContent from '@aurodesignsystem/auro-[component]/demo/demo.md'
9:const markdownContent = 'https://raw.githubusercontent.com/AlaskaAirlines/auro-tokenlist/main/demo/demo.md';

AuroDocsSite/src/content/markdown/codetest.md
43:1. Complete the `./demo/demo.md` document to visually review the web component

input/package.json
125:            "./demo/demo.md",

interruption/demo/index.html
6:  All demo code should be edited in ./demo/demo.md
35:      fetch('/demo/demo.md')

interruption/demo/dialog.html
6:  All demo code should be edited in ./demo/demo.md

interruption/demo/drawer.html
6:  All demo code should be edited in ./demo/demo.md

interruption/package.json
129:    "demo:copyDemo": "copyfiles -u 1 -V './demo/demo.md' ./build/demo",

skeleton/build/index.html
20:      fetch('/demo/demo.md')

flight/build/index.html
20:      fetch('/demo/demo.md')

datepicker/package.json
124:            "./demo/demo.md",

checkbox/demo/index.html
6:  All demo code should be added/edited in ./demo/demo.md

checkbox/package.json
117:            "./demo/demo.md",

library/bin/generateDocs.mjs
126: * Compiles `./docTemplates/demo.md` -> `./demo/demo.md`
131:    if (fs.existsSync('./demo/demo.md')) {
132:      fs.readFile('./demo/demo.md', 'utf8', function(err, data) {
133:        formatTemplateFileContents(data, './demo/demo.md');
136:      console.log('ERROR: ./demo/demo.md file is missing');

blog/src/routes/components/[name]/index.js
7:			content: await parseGithubMarkdown(`AlaskaAirlines/auro-${params.name}/master/demo/demo.md`)

combobox/demo/index.html
6:  All demo code should be added/edited in ./demo/demo.md

combobox/demo/api.html
6:  All demo code should be added/edited in ./demo/demo.md

combobox/package.json
116:            "./demo/demo.md",

dialog/package.json
119:            "./demo/demo.md",

popover/package.json
118:            "./demo/demo.md",

button/CHANGELOG.md
218:modified:   demo/demo.md

table/demo/index.html
6:  All demo code should be added/edited in ./demo/demo.md
35:      fetch('/demo/demo.md')

table/package.json
117:            "./demo/demo.md",

table/scripts/generateDocs.mjs
126: * Compiles `./docTemplates/demo.md` -> `./demo/demo.md`
131:    if (fs.existsSync('./demo/demo.md')) {
132:      fs.readFile('./demo/demo.md', 'utf8', function(err, data) {
133:        formatTemplateFileContents(data, './demo/demo.md');
136:      console.log('ERROR: ./demo/demo.md file is missing');

loader/CHANGELOG.md
88:modified:   demo/demo.md

menu/demo/index.html
6:  All demo code should be added/edited in ./demo/demo.md

menu/package.json
120:            "./demo/demo.md",

select/demo/index.html
6:  All demo code should be added/edited in ./demo/demo.md

select/package.json
117:            "./demo/demo.md",

nav/demo/index.html
6:  All demo code should be added/edited in ./demo/demo.md

nav/demo/api.html
6:  All demo code should be added/edited in ./demo/demo.md

nav/package.json
122:            "./demo/demo.md",

tokenlist/demo/index.html
25:      fetch('/demo/demo.md')

tokenlist/package.json
151:    "demo:copy:demo": "copyfiles -u 1 -V './demo/demo.md' ./build/demo",

banner/package.json
118:            "./demo/demo.md",

badge/demo/api.html
6:  All demo code should be added/edited in ./demo/demo.md

badge/package.json
139:            "./demo/demo.md",