fix: docs for all

Author: ascariandrea

docs/docs/intro.md

@@ -2,46 +2,9 @@
 sidebar_position: 1
 ---
 
-# Tutorial Intro
+# TrEx
 
-Let's discover **Docusaurus in less than 5 minutes**.
+## Platforms
 
-## Getting Started
-
-Get started by **creating a new site**.
-
-Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
-
-### What you'll need
-
-- [Node.js](https://nodejs.org/en/download/) version 14 or above:
-  - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
-
-## Generate a new site
-
-Generate a new Docusaurus site using the **classic template**.
-
-The classic template will automatically be added to your project after you run the command:
-
-```bash
-npm init docusaurus@latest my-website classic
-```
-
-You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
-
-The command also installs all necessary dependencies you need to run Docusaurus.
-
-## Start your site
-
-Run the development server:
-
-```bash
-cd my-website
-npm run start
-```
-
-The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
-
-The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
-
-Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
+- [@tktrex](/tktrex/docs)
+- [@yttrex](/yttrex/docs)

docs/docs/partials/extension/_build.mdx

@@ -0,0 +1,15 @@
+import CodeBlock from '@theme/CodeBlock';
+
+## Build
+
+To produce a `production` extension run the following command in your terminal:
+
+<CodeBlock className="language-bash">
+  yarn {props.platformPrefix}:ext build
+</CodeBlock>
+
+Or, if you need a version with `NODE_ENV=development` run:
+
+<CodeBlock className="language-bash">
+  NODE_ENV=development yarn {props.platformPrefix}:ext build
+</CodeBlock>

docs/docs/partials/extension/_development.mdx

@@ -0,0 +1,24 @@
+import CodeBlock from '@theme/CodeBlock';
+
+
+## Development
+
+### Prerequisites
+
+<ul>
+  <li>
+    <a href="backend">
+      @{props.platformPrefix}trex/backend
+    </a>{" "}up and running
+  </li>
+</ul>
+
+### Run "watch" mode
+
+To start developing the extension you need to compile the source code with `webpack` by running the following command:
+
+<CodeBlock className="language-bash">
+  yarn {props.platformPrefix}:ext watch
+</CodeBlock>
+
+<p>then, you can open your browser's development panel and load the extension from the output folder <i>{props.platformPrefix}</i>.</p>

docs/docs/partials/extension/_index.mdx

@@ -0,0 +1,11 @@
+import ExtensionDevelopmentPartial from './_development.mdx';
+import ExtensionBuildPartial from './_build.mdx'
+
+<p>
+  This browser extension allows you to contribute to our researches and tracking
+  algorithm analyses on <b>{props.platformName}</b>.
+</p>
+
+<ExtensionDevelopmentPartial platformName={props.platformName} platformPrefix={props.platformPrefix} />
+
+<ExtensionBuildPartial platformName={props.platformName} platformPrefix={props.platformPrefix} />

docs/docusaurus.config.js

@@ -3,13 +3,18 @@
 
 // const lightCodeTheme = require('prism-react-renderer/themes/github');
 const darkCodeTheme = require('prism-react-renderer/themes/dracula');
-const path = require('path/posix');
-const { default: theme } = require('./theme');
+const lightCodeTheme = require('prism-react-renderer/themes/github');
+const packageJson = require('../package.json');
+const path = require('path');
+// const { default: theme } = require('./theme');
+
+const GITHUB_REPO = 'https://github.com/tracking-exposed/yttrex';
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
   title: '@trex',
-  tagline: 'Dinosaurs are cool',
+  tagline:
+    'We develop tools to uncover how tracking and profiling have an impact on society',
   url: 'https://docs.tracking.exposed',
   baseUrl: '/',
   onBrokenLinks: 'throw',
@@ -19,24 +24,49 @@ const config = {
   projectName: 'trex', // Usually your repo name.
 
   plugins: [
-    // @tktrex open api
+    // @tktrex
+    // api
     [
       'docusaurus-plugin-openapi',
       {
         id: 'tktrex',
-        path: '../platforms/tktrex/shared/build/openapi-tktrex.json',
+        path: '../platforms/tktrex/shared/build/open-api.json',
         routeBasePath: 'tktrex/api',
       },
     ],
-    // @tktrex open api
-    // [
-    //   'docusaurus-plugin-openapi',
-    //   {
-    //     id: 'ycai-api',
-    //     path: '../sercices/ycai/studio/docs/openapi-validated.json',
-    //     routeBasePath: 'ycai/api',
-    //   },
-    // ],
+    // docs
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'tk-docs',
+        path: path.resolve(__dirname, '../platforms/tktrex/docs/docs'),
+        routeBasePath: 'tktrex/docs',
+        sidebarPath: require.resolve('./sidebars.js'),
+      },
+    ],
+    // @yttrex
+    // API
+    [
+      'docusaurus-plugin-openapi',
+      {
+        id: 'yttrex-api',
+        path: '../platforms/yttrex/backend/build/open-api.json',
+        routeBasePath: 'yttrex/api',
+      },
+    ],
+    // docs
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'yttrex-docs',
+        path: path.resolve(__dirname, '../platforms/yttrex/docs/docs'),
+        routeBasePath: 'yttrex/docs',
+        sidebarPath: require.resolve('./sidebars.js'),
+      },
+    ],
+
+    // tools
+    // guardoni
     [
       '@docusaurus/plugin-content-docs',
       {
@@ -46,15 +76,6 @@ const config = {
         sidebarPath: require.resolve('./sidebars.js'),
       },
     ],
-    // [
-    //   '@docusaurus/plugin-content-docs',
-    //   {
-    //     id: 'ycai-docs',
-    //     path: path.resolve(__dirname, '../YCAI/docs'),
-    //     routeBasePath: 'ycai/docs',
-    //     sidebarPath: require.resolve('../YCAI/sidebars.js'),
-    //   },
-    // ],
   ],
   presets: [
     [
@@ -79,39 +100,40 @@ const config = {
     /** @type {import('docusaurus-theme-openapi').ThemeConfig} */
     ({
       navbar: {
-        title: '@trex',
+        title: `@tktrex v${packageJson.version}`,
         logo: {
           alt: '@trex Logo',
           src: 'img/yttrex128.png',
         },
         items: [
           {
-            type: 'dropdown',
-            label: 'Services',
-            items: [
-              {
-                type: 'doc',
-                docId: 'intro',
-                docsPluginId: 'guardoni-docs',
-                label: 'Guardoni',
-              },
-              {
-                type: 'doc',
-                docId: 'intro',
-                docsPluginId: 'ycai-docs',
-                label: 'YCAI',
-              },
-            ],
+            type: 'doc',
+            label: 'Guardoni',
+            docId: 'guardoni-intro',
+            docsPluginId: 'guardoni-docs'
+          },
+          {
+            type: 'doc',
+            docId: 'intro',
+            docsPluginId: 'tk-docs',
+            label: 'TikTok Scraper',
+          },
+          {
+            type: 'doc',
+            docId: 'yttrex-intro',
+            docsPluginId: 'yttrex-docs',
+            label: 'Youtube Scraper',
           },
           {
             type: 'dropdown',
             label: 'API',
             items: [
               { to: '/tktrex/api', label: '@tktrex' },
+              { to: '/yttrex/api', label: '@yttrex' },
               { to: '/ycai/api', label: '@ycai' },
             ],
           },
-          { to: '/blog', label: 'Blog', position: 'left' },
+          // { to: '/blog', label: 'Blog', position: 'left' },
           {
             href: 'https://github.com/facebook/docusaurus',
             label: 'GitHub',
@@ -125,7 +147,7 @@ const config = {
             title: 'Docs',
             items: [
               {
-                label: 'Tutorial',
+                label: 'Getting started',
                 to: '/docs/intro',
               },
             ],
@@ -134,37 +156,58 @@ const config = {
             title: 'Community',
             items: [
               {
-                label: 'Stack Overflow',
-                href: 'https://stackoverflow.com/questions/tagged/docusaurus',
-              },
-              {
-                label: 'Discord',
-                href: 'https://discordapp.com/invite/docusaurus',
+                label: 'Slack',
+                href: 'https://trackingexposed.slack.com/invite/trex-tk',
               },
               {
                 label: 'Twitter',
-                href: 'https://twitter.com/docusaurus',
+                href: 'https://twitter.com/trackingexposed',
               },
             ],
           },
           {
             title: 'More',
             items: [
               {
-                label: 'Blog',
-                to: '/blog',
+                label: 'Youchoose',
+                to: 'https://youchoose.ai',
+              },
+              {
+                label: '@trex/facebook',
+                to: 'https://facebook.tracking.exposed',
+              },
+              {
+                label: '@trex/youtube',
+                to: 'https://youtube.tracking.exposed',
               },
               {
-                label: 'GitHub',
-                href: 'https://github.com/facebook/docusaurus',
+                label: '@trex/pornhub',
+                to: 'https://pornhub.tracking.exposed',
+              },
+              {
+                label: '@trex/amazon',
+                to: 'https://amazon.tracking.exposed',
+              },
+              // no blog at the moment
+              // {
+              //   label: 'Blog',
+              //   to: '/blog',
+              // },
+            ],
+          },
+          {
+            title: 'Dev',
+            items: [
+              {
+                html: `<a class="header-github-link" href="${GITHUB_REPO}" target="_blank" rel="noreferrer"></a>`,
               },
             ],
           },
         ],
         copyright: `Copyright © ${new Date().getFullYear()} Tracking Exposed Team. Built with Docusaurus.`,
       },
       prism: {
-        theme: theme,
+        theme: lightCodeTheme,
         darkTheme: darkCodeTheme,
       },
     }),

docs/sidebars.js

@@ -16,14 +16,12 @@
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
   // By default, Docusaurus generates a sidebar from the docs folder structure
-  tutorialSidebar: [
-    { type: 'autogenerated', dirName: '.' },
-    // {
-    //   type: 'link',
-    //   label: '@ycai',
-    //   href: '/ycai/intro',
-    // },
-  ],
+  tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
+  // {
+  //   type: 'link',
+  //   label: '@ycai',
+  //   href: '/ycai/intro',
+  // },
 
   // But you can create a sidebar manually
   /*