docs: content reorg

molant · molant · commit e9be34d536d0 · 2021-07-22T12:15:50.000-07:00
diff --git a/docs/browser-engine.md b/docs/browser-engine.md
@@ -1,6 +1,5 @@
 ---
-id: overview
-slug: /browser-engine
+id: browser-engine
 ---
 
 # Overview
@@ -200,7 +199,7 @@ There are many strategies in here, each one with its pros and cons:
 [Safari]: https://www.apple.com/safari/
 [statcounter]: https://gs.statcounter.com/browser-market-share
 [Tauri]: https://tauri.studio/
-[Types of technologies]: ../types.md
+[Types of technologies]: ./types.md
 [V8]: https://en.wikipedia.org/wiki/V8_(JavaScript_engine)
 [WebKit]: https://webkit.org/
 [WebSockets]: https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API
diff --git a/docs/comparison.md b/docs/comparison.md
@@ -1 +1,5 @@
+---
+title: Technology comparison
+---
+
 Coming soon(-ish)!
diff --git a/docs/direct-drawing.md b/docs/direct-drawing.md
@@ -0,0 +1,8 @@
+---
+title: Direct drawing
+id: direct-drawing
+---
+
+# Direct drawing
+
+TBD
diff --git a/docs/direct-drawing/direct-drawing.md b/docs/direct-drawing/direct-drawing.md
diff --git a/docs/electron.md b/docs/electron.md
diff --git a/docs/intro.md b/docs/intro.md
@@ -1,6 +1,6 @@
 ---
 title: Why cross-platform development?
-slug: /introduction
+id: intro
 ---
 
 # Why cross-platform development?
diff --git a/docs/platform-controls.md b/docs/platform-controls.md
@@ -0,0 +1,8 @@
+---
+title: Platform controls
+id: platform-controls
+---
+
+# Platform controls
+
+TBD
diff --git a/docs/platform-controls/platform-controls.md b/docs/platform-controls/platform-controls.md
diff --git a/docs/snippets.md b/docs/snippets.md
@@ -1 +1,5 @@
+---
+title: Code snippets
+---
+
 Coming soon(-ish)!
diff --git a/docs/types.md b/docs/types.md
@@ -51,11 +51,11 @@ is easier to rationalize. If you believe there is a better way, please [let us k
 <!-- TODO: Add a diagram representing the above -->
 
 [Apache Cordova]: https://cordova.apache.org/
-[Browser engine]: ./browser-engine/browser-engine.md
+[Browser engine]: ./browser-engine.md
 [Chromium]: http://www.chromium.org/Home
 [Chrome]: https://www.google.com/chrome/index.html
 [Chromium Embedded Framework]: https://bitbucket.org/chromiumembedded/cef/wiki/Home
-[Direct drawing]: ./direct-drawing/direct-drawing.md
+[Direct drawing]: ./direct-drawing.md
 [Edge]: https://www.microsoft.com/en-us/edge
 [Electron]: https://www.electronjs.org
 [Firefox]: https://www.mozilla.org/en-US/firefox/new/
@@ -65,7 +65,7 @@ is easier to rationalize. If you believe there is a better way, please [let us k
 [Ionic]: https://ionicframework.com/
 [NativeScript]: https://nativescript.org/
 [NW.js]: https://nwjs.io/
-[Platform controls]: ./platform-controls/platform-controls.md
+[Platform controls]: ./platform-controls.md
 [Progressive Web Apps]: https://web.dev/progressive-web-apps/
 [Project Fugu]: https://web.dev/fugu-status/
 [Qt]: https://www.qt.io/
diff --git a/docs/webview2.md b/docs/webview2.md
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -21,9 +21,9 @@ module.exports = {
       items: [
         {
           type: 'doc',
-          docId: 'intro',
+          docId: 'types',
           position: 'left',
-          label: 'Why?',
+          label: 'Types of technologies',
         },
         // {to: '/blog', label: 'Blog', position: 'left'},
         {
diff --git a/scripts/add-technology.js b/scripts/add-technology.js
@@ -12,7 +12,6 @@ const TECHNOLOGY_TEMPLATE_PATH = path.join(
   'technology'
 );
 const DATA_PATH = path.join(__dirname, '..', 'data');
-const TECHNOLOGIES_PATH = path.join(DATA_PATH, 'technologies');
 const SIDEBARS_PATH = path.join(__dirname, '..', 'sidebars.js');
 // TODO: Create this from the schema so it's easier to maintain
 const TECHNOLOGY = {
@@ -202,7 +201,7 @@ ${createdFiles.join('\n')}`);
   const json = { ...TECHNOLOGY, ...{ name: technology } };
 
   await fs.writeFile(
-    path.join(TECHNOLOGIES_PATH, `${normalizedTechnology}.json`),
+    path.join(DATA_PATH, `${normalizedTechnology}.json`),
     JSON.stringify(json, null, 2),
     'utf-8'
   );
@@ -220,7 +219,7 @@ ${createdFiles.join('\n')}`);
 
   console.log(`Updating sidebars.js`);
 
-  categoryItem.items.push(`${normalizedCategory}/${normalizedTechnology}`);
+  categoryItem.items.push(normalizedTechnology);
 
   await fs.writeFile(
     SIDEBARS_PATH,
diff --git a/sidebars.js b/sidebars.js
@@ -1,21 +1,16 @@
 module.exports = {
   websiteSidebar: [
-    {
-      type: 'category',
-      label: 'Cross-platform development',
-      items: [
-        'intro',
-        'types',
-      ],
-    },
+    'types',
     {
       type: 'category',
       label: 'Browser engine',
       items: [
-        'browser-engine/overview',
-        'browser-engine/electron',
-        'browser-engine/webview2',
+        'browser-engine',
+        'electron',
+        'webview2',
       ],
     },
+    'direct-drawing',
+    'platform-controls'
   ],
 };
diff --git a/src/components/HomepageFeatures.js b/src/components/HomepageFeatures.js
@@ -41,9 +41,9 @@ function Feature({ Svg, title, description, link }) {
   return (
     <div className={clsx('col col--4')}>
         <a href={link}>
-        <div className="text--center">
+        {/* <div className="text--center">
           <Svg className={styles.featureSvg} alt={title} />
-        </div>
+        </div> */}
         </a>
         <div className="text--center padding-horiz--md">
           <h3><a href={link}>{title}</a></h3>
diff --git a/src/pages/index.js b/src/pages/index.js
@@ -16,7 +16,7 @@ function HomepageHeader() {
         <div className={styles.buttons}>
           <Link
             className="button button--secondary button--lg"
-            to="/docs/introduction">
+            to="/docs/types">
             Find out more
           </Link>
         </div>

-Original file line number
+Diff line change
@@ @@ -1 +1,5 @@ @@
 +---
 +title: Technology comparison
 +---
++
 Coming soon(-ish)!