fix(baseline): Reorganization of documents.

phase2 · Nov 8, 2023 · 0176860 · 0176860
1 parent a9638ee
commit 0176860
Show file tree

Hide file tree

Showing 26 changed files with 27 additions and 96 deletions.
diff --git a/.storybook/main.js b/.storybook/main.js
@@ -1,18 +1,14 @@
 import { dirname, join } from 'path';
-//const outlineConfig = require('../outline.config');
 
 module.exports = {
   stories: [
     // Intentionally ordering welcome page first.
-    '../packages/documentation/outline-docs/src/guides/welcome.mdx',
+    '../packages/documentation/outline-docs/src/guides/welcome/00-welcome.mdx',
+    '../packages/documentation/outline-docs/src/guides/welcome/more-information/*.mdx',
+    // Tooling usage guides.
+    '../packages/documentation/outline-docs/src/guides/development/tooling/**/*.mdx',
     // Component development guides.
     '../packages/documentation/outline-docs/src/guides/development/component-development/**/*.mdx',
-    // Component usage guides.
-    '../packages/documentation/outline-docs/src/guides/consumers/**/*.mdx',
-    // QA/UAT usage guides.
-    '../packages/documentation/outline-docs/src/guides/qa-uat/**/*.mdx',
-    // Tooling usage guides.
-    '../packages/documentation/outline-docs/src/guides/tooling/**/*.mdx',
     // Documentation stories.
     '../packages/documentation/outline-docs/src/guides/**/*.@(js|ts|mdx)',
     // Modern component stories.
@@ -31,18 +27,14 @@ module.exports = {
     storyStoreV7: true,
     postcss: true,
     buildStoriesJson: true,
-    modernInlineRender: true,
+    modernInlineRender: false,
   },
   framework: {
-    name: getAbsolutePath('@storybook/web-components-vite'),
+    name: '@storybook/web-components-vite',
     options: {},
   },
   docs: {
     autodocs: true,
     defaultName: 'Documentation', // set to change the name of generated docs entries
   },
 };
-
-function getAbsolutePath(value) {
-  return dirname(require.resolve(join(value, 'package.json')));
-}
diff --git a/.storybook/preview.js b/.storybook/preview.js
@@ -10,15 +10,13 @@ export const parameters = {
   options: {
     storySort: {
       order: [
-        'Getting Started',
-        'Documentation',
-        'Design Tokens',
+        'Welcome Guide',
+        'Coding Guide',
         'Media',
         'Navigation',
         'Content',
         'Templates',
         'Pages',
-        'Code Examples',
         'Utility Components',
       ],
     },

diff --git a/...evelopment/component-development/main.mdx → ...lopment/component-development/00-main.mdx b/...evelopment/component-development/main.mdx → ...lopment/component-development/00-main.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Component Development/Coding Guide & Standards"
+  title="Coding Guide/Component Development"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...ne-docs/src/guides/development/component-development/01-component-structure.mdx b/...ne-docs/src/guides/development/component-development/01-component-structure.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Component Development/Coding Guide & Standards/Component Structure"
+  title="Coding Guide/Component Development/Component Structure"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...ntation/outline-docs/src/guides/development/component-development/03-styles.mdx b/...ntation/outline-docs/src/guides/development/component-development/03-styles.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Component Development/Coding Guide & Standards/Styling"
+  title="Coding Guide/Component Development/Styling"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...on/outline-docs/src/guides/development/component-development/04-controllers.mdx b/...on/outline-docs/src/guides/development/component-development/04-controllers.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Component Development/Coding Guide & Standards/Controllers"
+  title="Coding Guide/Component Development/Controllers"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...ntation/outline-docs/src/guides/development/component-development/05-render.mdx b/...ntation/outline-docs/src/guides/development/component-development/05-render.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Component Development/Coding Guide & Standards/Render"
+  title="Coding Guide/Component Development/Render"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...ion/outline-docs/src/guides/development/component-development/06-properties.mdx b/...ion/outline-docs/src/guides/development/component-development/06-properties.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Component Development/Coding Guide & Standards/Properties"
+  title="Coding Guide/Component Development/Properties"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...entation/outline-docs/src/guides/development/component-development/07-slots.mdx b/...entation/outline-docs/src/guides/development/component-development/07-slots.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Component Development/Coding Guide & Standards/Slots"
+  title="Coding Guide/Component Development/Slots"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...line-docs/src/guides/development/component-development/08-lifecycle-methods.mdx b/...line-docs/src/guides/development/component-development/08-lifecycle-methods.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Component Development/Coding Guide & Standards/Lifecycle"
+  title="Coding Guide/Component Development/Lifecycle"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...ntation/outline-docs/src/guides/development/component-development/09-events.mdx b/...ntation/outline-docs/src/guides/development/component-development/09-events.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Component Development/Coding Guide & Standards/Event Handlers"
+  title="Coding Guide/Component Development/Event Handlers"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...line-docs/src/guides/development/component-development/10-utility-functions.mdx b/...line-docs/src/guides/development/component-development/10-utility-functions.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Component Development/Coding Guide & Standards/Utility Functions"
+  title="Coding Guide/Component Development/Utility Functions"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...tion/outline-docs/src/guides/development/component-development/11-extending.mdx b/...tion/outline-docs/src/guides/development/component-development/11-extending.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Component Development/Coding Guide & Standards/Extending Components"
+  title="Coding Guide/Component Development/Extending Components"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...ne-docs/src/guides/tooling/01-tooling.mdx → ...guides/development/tooling/01-tooling.mdx b/...ne-docs/src/guides/tooling/01-tooling.mdx → ...guides/development/tooling/01-tooling.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Tooling & Commands/About Outline"
+  title="Coding Guide/Tooling/About Outline"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...rc/guides/tooling/02-helpful-commands.mdx → ...velopment/tooling/02-helpful-commands.mdx b/...rc/guides/tooling/02-helpful-commands.mdx → ...velopment/tooling/02-helpful-commands.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Tooling & Commands/Helpful Commands"
+  title="Coding Guide/Tooling/Helpful Commands"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...uides/tooling/03-conventional-commits.mdx → ...pment/tooling/03-conventional-commits.mdx b/...uides/tooling/03-conventional-commits.mdx → ...pment/tooling/03-conventional-commits.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Tooling & Commands/Conventional Commits"
+  title="Coding Guide/Tooling/Conventional Commits"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...c/guides/tooling/04-production-builds.mdx → ...elopment/tooling/04-production-builds.mdx b/...c/guides/tooling/04-production-builds.mdx → ...elopment/tooling/04-production-builds.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Tooling & Commands/Production Builds"
+  title="Coding Guide/Tooling/Production Builds"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...docs/src/guides/tooling/06-changesets.mdx → ...des/development/tooling/06-changesets.mdx b/...docs/src/guides/tooling/06-changesets.mdx → ...des/development/tooling/06-changesets.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Tooling & Commands/Versioning with Changesets"
+  title="Coding Guide/Tooling/Versioning with Changesets"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/packages/documentation/outline-docs/src/guides/tooling/05-unit-testing.mdx b/packages/documentation/outline-docs/src/guides/tooling/05-unit-testing.mdx
diff --git a/...ation/outline-docs/src/guides/welcome.mdx → ...ne-docs/src/guides/welcome/00-welcome.mdx b/...ation/outline-docs/src/guides/welcome.mdx → ...ne-docs/src/guides/welcome/00-welcome.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Welcome"
+  title="Welcome Guide/Welcome"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...s/development/99-additional-resources.mdx → ...e-information/99-additional-resources.mdx b/...s/development/99-additional-resources.mdx → ...e-information/99-additional-resources.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Component Development/Resources"
+  title="Welcome Guide/More Information/Resources"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...cs/src/guides/tooling/99-contributing.mdx → ...come/more-information/99-contributing.mdx b/...cs/src/guides/tooling/99-contributing.mdx → ...come/more-information/99-contributing.mdx
@@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
 import '@phase2/outline-core-alert';
 
 <Meta
-  title="Documentation/Tooling & Commands/Contributing to Outline"
+  title="Welcome Guide/More Information/Contributing to Outline"
   parameters={{
     viewMode: 'docs',
     previewTabs: {

diff --git a/...ges/documentation/outline-docs/src/screenshots/outline-accordion--storybook.png b/...ges/documentation/outline-docs/src/screenshots/outline-accordion--storybook.png
diff --git a/...ages/documentation/outline-docs/src/screenshots/outline-accordion--yarn-add.png b/...ages/documentation/outline-docs/src/screenshots/outline-accordion--yarn-add.png
diff --git a/...s/documentation/outline-docs/src/screenshots/outline-admin-links--storybook.png b/...s/documentation/outline-docs/src/screenshots/outline-admin-links--storybook.png
diff --git a/...es/documentation/outline-docs/src/screenshots/outline-admin-links--yarn-add.png b/...es/documentation/outline-docs/src/screenshots/outline-admin-links--yarn-add.png