chore: reorganize content and technology template

Reorganize the documentation to make it more streamlined.

Author: molant

docs/types-of-xplat/browser-engine.md renamed to docs/browser-engine/browser-engine.md

@@ -1,8 +1,9 @@
 ---
-id: browser
+id: overview
+slug: /browser-engine
 ---
 
-# Browser engine
+# Overview
 
 Cross-platform technologies that use a browser engine (also called rendering engine) to render
 their UI have been around for many years, more precisely since 2009. Chrome was released the year
@@ -134,5 +135,5 @@ There are many strategies in here, each one with its pros and cons:
 [NW.js]: https://nwjs.io/
 [Tauri]: https://tauri.studio/
 [V8]: https://en.wikipedia.org/wiki/V8_(JavaScript_engine)
-[Web and PWA]: ./web.md
-[WebSockets]: https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API
+[Web and PWA]: ../web/web.md
+[WebSockets]: https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API

docs/types-of-xplat/compiled.md renamed to docs/compiled/compiled.md

@@ -1,5 +1,6 @@
 ---
 title: Why cross-platform development?
+slug: /introduction
 ---
 
 # Why cross-platform development?

docs/intro.md

@@ -28,24 +28,24 @@ are:
 
 <!-- TODO: Add a diagram representing the above -->
 
-[Browser engine]: ./browser-engine.md
+[Browser engine]: ./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
-[Compiled]: ./compiled.md
+[Compiled]: ./compiled/compiled.md
 [Edge]: https://www.microsoft.com/en-us/edge
 [Electron]: https://www.electronjs.org
 [Firefox]: https://www.mozilla.org/en-US/firefox/new/
 [Flutter]: https://flutter.dev/
 [Gecko]: https://developer.mozilla.org/en-US/docs/Mozilla/Gecko
-[JavaScript projection]: ./javascript-projection.md
+[JavaScript projection]: ./javascript-projection/javascript-projection.md
 [NativeScript]: https://nativescript.org/
 [NodeGui]: https://docs.nodegui.org/
 [NW.js]: https://nwjs.io/
 [Qt]: https://www.qt.io/
 [React Native]: https://reactnative.dev
 [Safari]: https://www.apple.com/safari/
 [Tauri]: https://tauri.studio/
-[Web]: ./web.md
+[Web]: ./web/web.md
 [WebKit]: https://webkit.org/
 [Xamarin]: https://dotnet.microsoft.com/apps/xamarin

docs/types-of-xplat/javascript-projection.md renamed to docs/javascript-projection/javascript-projection.md

@@ -1,5 +1,6 @@
 ---
-
+id: web
+slug: /web
 ---
 
 # Web and PWA

docs/types-of-xplat/types.md renamed to docs/types.md

@@ -23,7 +23,7 @@ module.exports = {
           type: 'doc',
           docId: 'intro',
           position: 'left',
-          label: 'Introduction',
+          label: 'cross-platform development',
         },
         // {to: '/blog', label: 'Blog', position: 'left'},
         {

docs/types-of-xplat/web.md renamed to docs/web/web.md

@@ -39,6 +39,13 @@ const TECHNOLOGY = {
   documentation: 'https://',
 };
 
+const categories = [
+  'Browser engine',
+  'Compiled',
+  'JavaScript projection',
+  'Web',
+];
+
 /**
  * Listens for stdin and returns the first line of text received.
  * @returns {Promise<string>}
@@ -133,7 +140,9 @@ const writeTemplates = async (templates, information, destination) => {
   const files = [];
 
   for (const [filePath, content] of templates) {
-    const finalPath = path.join(destination, filePath);
+    // 🛑 HACK ahead!! we assume that `information[1]` is `normalizedTechnology`. We should probably validate this
+    const finalPath = path.join(destination, filePath).replace('technology', information[1].value);
+
     const interpolatedContent = interpolate(content, information);
 
     await fs.writeFile(finalPath, interpolatedContent, 'utf-8');
@@ -148,6 +157,15 @@ const start = async () => {
   const technology = await getInput();
   const normalizedTechnology = normalize(technology);
 
+  console.log(`Category? (${categories.join(', ')})`);
+  const category = await getInput();
+
+  if (!categories.includes(category)) {
+    console.error(`Category "${category}" is not valid. Please use one of the following ones the next time:
+${categories.join('\n')}`);
+  }
+  const normalizedCategory = normalize(category);
+
   const templates = await loadTemplates('.md');
 
   const information = [
@@ -159,12 +177,20 @@ const start = async () => {
       key: 'normalizedTechnology',
       value: normalizedTechnology,
     },
+    {
+      key: 'category',
+      value: category,
+    },
+    {
+      key: 'normalizedCategory',
+      value: normalizedCategory,
+    },
   ];
 
   const createdFiles = await writeTemplates(
     templates,
     information,
-    path.join(DOCS_ROOT, normalizedTechnology)
+    path.join(DOCS_ROOT, normalizedCategory)
   );
 
   console.log(`Documentation files created:
@@ -178,17 +204,21 @@ ${createdFiles.join('\n')}`);
     'utf-8'
   );
 
-  const category = {
-    type: 'category',
-    label: technology,
-    items: [{ type: 'autogenerated', dirName: normalizedTechnology }],
-  };
-
   const sidebars = require(SIDEBARS_PATH);
 
-  sidebars.websiteSidebar.push(category);
+  const categoryItem = sidebars.websiteSidebar.find((item) =>{
+    return item.label === category;
+  });
+
+  if(!categoryItem){
+    console.error(`There was an error adding the element to "sidebars.js" under the category ${category}, please do it manually`);
+    process.exit(1);
+  }
 
   console.log(`Updating sidebars.js`);
+
+  categoryItem.items.push(`${normalizedCategory}/${normalizedTechnology}`);
+
   await fs.writeFile(
     SIDEBARS_PATH,
     `module.exports = ${stringify(sidebars, null, 2)};\n`,