From 46e9724e2267f81cfc621a71ff20f231c7326053 Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Tue, 12 Nov 2024 11:36:18 -0800 Subject: [PATCH] Add index.mdx and remove category.json --- .../custom-components/_category_.json | 8 -------- docs/design-system/custom-components/index.mdx | 16 ++++++++++++++++ .../building-your-application/_category_.json | 8 -------- .../available-scripts/_category_.json | 9 --------- .../{available-scripts.md => index.mdx} | 15 +++++++++++++++ .../available-scripts/installing-cli.md | 4 ++++ .../available-scripts/running-example.md | 4 ++++ .../development-life-cycle.md | 2 +- .../development-standards.md | 2 +- .../building-your-application/index.mdx | 16 ++++++++++++++++ .../patterns/_category_.json | 8 -------- .../building-your-application/patterns/index.mdx | 16 ++++++++++++++++ .../service-worker-removal.md | 2 +- .../examples/_category_.json | 8 -------- .../examples-and-templates/examples/index.mdx | 16 ++++++++++++++++ .../libraries/_category_.json | 8 -------- docs/developer-documentation/libraries/index.mdx | 16 ++++++++++++++++ .../technical-decision-log/_category_.json | 8 -------- .../technical-decision-log/index.mdx | 16 ++++++++++++++++ 19 files changed, 122 insertions(+), 60 deletions(-) delete mode 100644 docs/design-system/custom-components/_category_.json create mode 100644 docs/design-system/custom-components/index.mdx delete mode 100644 docs/developer-documentation/building-your-application/_category_.json delete mode 100644 docs/developer-documentation/building-your-application/available-scripts/_category_.json rename docs/developer-documentation/building-your-application/available-scripts/{available-scripts.md => index.mdx} (92%) create mode 100644 docs/developer-documentation/building-your-application/index.mdx delete mode 100644 docs/developer-documentation/building-your-application/patterns/_category_.json create mode 100644 docs/developer-documentation/building-your-application/patterns/index.mdx delete mode 100644 docs/developer-documentation/examples-and-templates/examples/_category_.json create mode 100644 docs/developer-documentation/examples-and-templates/examples/index.mdx delete mode 100644 docs/developer-documentation/libraries/_category_.json create mode 100644 docs/developer-documentation/libraries/index.mdx delete mode 100644 docs/developer-documentation/technical-decision-log/_category_.json create mode 100644 docs/developer-documentation/technical-decision-log/index.mdx diff --git a/docs/design-system/custom-components/_category_.json b/docs/design-system/custom-components/_category_.json deleted file mode 100644 index 6481651..0000000 --- a/docs/design-system/custom-components/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "RADFish Custom Components", - "position": 1, - "link": { - "type": "generated-index", - "slug": "/design-system/custom-components" - } -} diff --git a/docs/design-system/custom-components/index.mdx b/docs/design-system/custom-components/index.mdx new file mode 100644 index 0000000..ed2099b --- /dev/null +++ b/docs/design-system/custom-components/index.mdx @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +--- + +# RADFish Custom Components + +{/* Write top text here */} + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; + + +``` + +{/* Write bottom text here */} diff --git a/docs/developer-documentation/building-your-application/_category_.json b/docs/developer-documentation/building-your-application/_category_.json deleted file mode 100644 index 9a82cbe..0000000 --- a/docs/developer-documentation/building-your-application/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Building Your Application", - "position": 3, - "link": { - "type": "generated-index", - "slug": "developer-documentation/building-your-application" - } -} diff --git a/docs/developer-documentation/building-your-application/available-scripts/_category_.json b/docs/developer-documentation/building-your-application/available-scripts/_category_.json deleted file mode 100644 index c48cb46..0000000 --- a/docs/developer-documentation/building-your-application/available-scripts/_category_.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "label": "Available Scripts", - "position": 7, - "link": { - "type": "generated-index", - "slug": "developer-documentation/building-your-application/patterns" - } - } - \ No newline at end of file diff --git a/docs/developer-documentation/building-your-application/available-scripts/available-scripts.md b/docs/developer-documentation/building-your-application/available-scripts/index.mdx similarity index 92% rename from docs/developer-documentation/building-your-application/available-scripts/available-scripts.md rename to docs/developer-documentation/building-your-application/available-scripts/index.mdx index 17a2ff7..751a411 100644 --- a/docs/developer-documentation/building-your-application/available-scripts/available-scripts.md +++ b/docs/developer-documentation/building-your-application/available-scripts/index.mdx @@ -1,5 +1,20 @@ +--- +sidebar_position: 4 +--- + # Available Scripts +{/* Write top text here */} + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; + + +``` + +{/* Write bottom text here */} + **`npm start`** This script starts the Vite development server. It runs the app locally with hot module reloading, allowing for fast development and instant updates as you make changes. Open [http://localhost:3000](http://localhost:3000/) to view it in the browser. diff --git a/docs/developer-documentation/building-your-application/available-scripts/installing-cli.md b/docs/developer-documentation/building-your-application/available-scripts/installing-cli.md index be26aab..39a94e1 100644 --- a/docs/developer-documentation/building-your-application/available-scripts/installing-cli.md +++ b/docs/developer-documentation/building-your-application/available-scripts/installing-cli.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 1 +--- + # Installing the CLI The RADFish CLI is available as an npm package, making the installation process much simpler. Follow these steps to install and use the CLI: diff --git a/docs/developer-documentation/building-your-application/available-scripts/running-example.md b/docs/developer-documentation/building-your-application/available-scripts/running-example.md index 54ce63d..1aa0b8c 100644 --- a/docs/developer-documentation/building-your-application/available-scripts/running-example.md +++ b/docs/developer-documentation/building-your-application/available-scripts/running-example.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 2 +--- + # Running an Example RADFish ships with several different [boilerplate examples](../../examples-and-templates#examples) that demonstrate core pieces of functionality identified as critical for NOAA application development. You can use these examples as a reference point to build out your own implementation, or simply to get inspiration for your own design patterns with some pre-defined best practices. diff --git a/docs/developer-documentation/building-your-application/development-life-cycle.md b/docs/developer-documentation/building-your-application/development-life-cycle.md index 029594e..fad076b 100644 --- a/docs/developer-documentation/building-your-application/development-life-cycle.md +++ b/docs/developer-documentation/building-your-application/development-life-cycle.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 1 description: Setting up web projects with RADFish --- diff --git a/docs/developer-documentation/building-your-application/development-standards.md b/docs/developer-documentation/building-your-application/development-standards.md index 4951fdb..b578790 100644 --- a/docs/developer-documentation/building-your-application/development-standards.md +++ b/docs/developer-documentation/building-your-application/development-standards.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 2 description: USWDS, NOAA branding and Styling, and 508 compliance --- diff --git a/docs/developer-documentation/building-your-application/index.mdx b/docs/developer-documentation/building-your-application/index.mdx new file mode 100644 index 0000000..bc4bada --- /dev/null +++ b/docs/developer-documentation/building-your-application/index.mdx @@ -0,0 +1,16 @@ +--- +sidebar_position: 3 +--- + +# Building Your Application + +{/* Write top text here */} + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; + + +``` + +{/* Write bottom text here */} diff --git a/docs/developer-documentation/building-your-application/patterns/_category_.json b/docs/developer-documentation/building-your-application/patterns/_category_.json deleted file mode 100644 index 2beca00..0000000 --- a/docs/developer-documentation/building-your-application/patterns/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Patterns", - "position": 6, - "link": { - "type": "generated-index", - "slug": "developer-documentation/building-your-application/patterns" - } -} diff --git a/docs/developer-documentation/building-your-application/patterns/index.mdx b/docs/developer-documentation/building-your-application/patterns/index.mdx new file mode 100644 index 0000000..a23e670 --- /dev/null +++ b/docs/developer-documentation/building-your-application/patterns/index.mdx @@ -0,0 +1,16 @@ +--- +sidebar_position: 3 +--- + +# Patterns + +{/* Write top text here */} + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; + + +``` + +{/* Write bottom text here */} diff --git a/docs/developer-documentation/building-your-application/service-worker-removal.md b/docs/developer-documentation/building-your-application/service-worker-removal.md index 5c02cc8..cfb5516 100644 --- a/docs/developer-documentation/building-your-application/service-worker-removal.md +++ b/docs/developer-documentation/building-your-application/service-worker-removal.md @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 7 title: Service Worker Removal --- diff --git a/docs/developer-documentation/examples-and-templates/examples/_category_.json b/docs/developer-documentation/examples-and-templates/examples/_category_.json deleted file mode 100644 index 2058686..0000000 --- a/docs/developer-documentation/examples-and-templates/examples/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Examples", - "position": 1, - "link": { - "type": "generated-index", - "slug": "developer-documentation/examples-and-templates/examples" - } -} diff --git a/docs/developer-documentation/examples-and-templates/examples/index.mdx b/docs/developer-documentation/examples-and-templates/examples/index.mdx new file mode 100644 index 0000000..9b962b0 --- /dev/null +++ b/docs/developer-documentation/examples-and-templates/examples/index.mdx @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +--- + +# Examples + +{/* Write top text here */} + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; + + +``` + +{/* Write bottom text here */} diff --git a/docs/developer-documentation/libraries/_category_.json b/docs/developer-documentation/libraries/_category_.json deleted file mode 100644 index f25f477..0000000 --- a/docs/developer-documentation/libraries/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Libraries", - "position": 4, - "link": { - "type": "generated-index", - "slug": "developer-documentation/libraries" - } -} diff --git a/docs/developer-documentation/libraries/index.mdx b/docs/developer-documentation/libraries/index.mdx new file mode 100644 index 0000000..4243581 --- /dev/null +++ b/docs/developer-documentation/libraries/index.mdx @@ -0,0 +1,16 @@ +--- +sidebar_position: 4 +--- + +# Libraries + +{/* Write top text here */} + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; + + +``` + +{/* Write bottom text here */} diff --git a/docs/developer-documentation/technical-decision-log/_category_.json b/docs/developer-documentation/technical-decision-log/_category_.json deleted file mode 100644 index dd6889a..0000000 --- a/docs/developer-documentation/technical-decision-log/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "RADFish Technical Decision Log", - "position": 6, - "link": { - "type": "generated-index", - "slug": "developer-documentation/technical-decision-log" - } -} diff --git a/docs/developer-documentation/technical-decision-log/index.mdx b/docs/developer-documentation/technical-decision-log/index.mdx new file mode 100644 index 0000000..19ce6c2 --- /dev/null +++ b/docs/developer-documentation/technical-decision-log/index.mdx @@ -0,0 +1,16 @@ +--- +sidebar_position: 5 +--- + +# RADFish Technical Decision Log + +{/* Write top text here */} + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; + + +``` + +{/* Write bottom text here */}