Restructure intro category to have better category flow

This shortens the welcome page to show a quick blurb and the category. The remaining details stay on the getting started page. Signed-off-by: Jeremy Ho <[email protected]>
bcgov · Dec 20, 2024 · 1c5374e · 1c5374e
1 parent 78c61cf
commit 1c5374e
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 21 deletions.
diff --git a/docs/intro/getting_started.md b/docs/intro/getting_started.md
@@ -2,20 +2,11 @@
 id: getting_started
 title: Getting Started
 description: Introduction to the Natural Resource Sector PIES
-sidebar_position: 1
 tags:
   - business
   - executive
 ---
 
-Welcome! This site repository contains common schemas related to permitting in the Natural Resources Sector for the
-Province of British Columbia. The intent of these are to standardize the way permitting in the Natural Resource Sector
-is described as data to enable quality and interoperability.
-
-Hosting this specification in the open will encourage collaboration, adoption and enable versioning.
-
-These will be reviewed and updated with relevant partners, data custodians, stewards and sector permitting teams.
-
 ## Purpose
 
 Permitting is a complex space. B.C.'s Natural Resource Sector (NRS) alone has well over 600 permit types with just as
@@ -78,7 +69,3 @@ and talk to each other in a common language).
 An Interoperability strategy and technology will be developed separately from the Data Standards. The strategy will
 focus on a stable, maintainable, scalable platform for data interchange with ability to transform data from LOB systems
 into the data standards.
-
-## Schemas
-
-TBD
diff --git a/docs/intro/welcome.mdx b/docs/intro/welcome.mdx
@@ -0,0 +1,25 @@
+---
+id: welcome
+title: Welcome
+description: Welcome to the Natural Resource Sector PIES
+sidebar_position: 1
+tags:
+  - business
+  - executive
+---
+
+import DocCardList from '@theme/DocCardList';
+
+Welcome! This site repository contains common schemas related to permitting in the Natural Resources Sector for the
+Province of British Columbia. The intent of these are to standardize the way permitting in the Natural Resource Sector
+is described as data to enable quality and interoperability.
+
+Hosting this specification in the open will encourage collaboration, adoption and enable versioning.
+
+These will be reviewed and updated with relevant partners, data custodians, stewards and sector permitting teams.
+
+You can dive into the specification [here](/docs/category/specification).
+
+---
+
+<DocCardList />
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -101,7 +101,7 @@ const config: Config = {
     },
     docs: {
       sidebar: {
-        autoCollapseCategories: false, // Flip to true when we have more content to help with navigation focus
+        autoCollapseCategories: true, // Flip to true when we have more content to help with navigation focus
         hideable: true
       }
     },

diff --git a/sidebars.ts b/sidebars.ts
@@ -29,22 +29,26 @@ const sidebars: SidebarsConfig = {
     {
       type: 'category',
       label: 'Introduction',
-      collapsed: false,
-      items: [{ type: 'autogenerated', dirName: 'intro' }]
+      collapsed: true,
+      items: [{ type: 'autogenerated', dirName: 'intro' }],
+      link: { type: 'doc', id: 'intro/welcome' }
     },
     {
       type: 'category',
       label: 'Specification',
-      collapsed: false,
-      items: [{ type: 'autogenerated', dirName: 'spec' }]
+      collapsed: true,
+      items: [{ type: 'autogenerated', dirName: 'spec' }],
+      link: { type: 'generated-index' }
     }
   ],
   // Make the default Docusaurus tutorial not a part of the main sidebar
   tutorialSidebar: [
     {
       type: 'category',
       label: 'Docusaurus Tutorial',
-      items: [{ type: 'autogenerated', dirName: 'docusaurus' }]
+      collapsed: true,
+      items: [{ type: 'autogenerated', dirName: 'docusaurus' }],
+      link: { type: 'generated-index' }
     }
   ]
 };

diff --git a/src/pages/index.tsx b/src/pages/index.tsx
@@ -22,9 +22,9 @@ function HomepageHeader() {
         <div className={styles.buttons}>
           <Link
             className="button button--secondary button--lg"
-            to="/docs/intro/getting_started"
+            to="/docs/intro/welcome"
           >
-            Get Started - 5min ⏱️
+            Explore PIES - 5min ⏱️
           </Link>
         </div>
       </div>