Merge pull request #162 from KomodoPlatform/dev

.github/workflows/get_data_lint_files_deploy.yml

@@ -7,24 +7,24 @@ on:
     types: [opened, edited, synchronize, reopened, ready_for_review]
 
 jobs:
-  # pre_job:
-  #   # continue-on-error: true # Uncomment once integration is finished
-  #   runs-on: ubuntu-latest
-  #   # Map a step output to a job output
-  #   outputs:
-  #     should_skip: ${{ steps.skip_check.outputs.should_skip }}
-  #   steps:
-  #     - id: skip_check
-  #       uses: fkirc/skip-duplicate-actions@v5
-  #       with:
-  #         # All of these options are optional, so you can remove them if you are happy with the defaults
-  #         concurrent_skipping: "never"
-  #         skip_after_successful_duplicate: "true"
-  #         do_not_skip: '["pull_request"]'
+  pre_job:
+    # continue-on-error: true # Uncomment once integration is finished
+    runs-on: ubuntu-latest
+    # Map a step output to a job output
+    outputs:
+      should_skip: ${{ steps.skip_check.outputs.should_skip }}
+    steps:
+      - id: skip_check
+        uses: fkirc/skip-duplicate-actions@v5
+        with:
+          # All of these options are optional, so you can remove them if you are happy with the defaults
+          concurrent_skipping: "never"
+          skip_after_successful_duplicate: "true"
+          do_not_skip: '["pull_request"]'
 
   update_lint_get_data:
-    # needs: pre_job
-    # if: needs.pre_job.outputs.should_skip != 'true' && startsWith(github.head_ref, 'lint-fix-patches') == false && github.event.pull_request.head.repo.full_name == github.repository
+    needs: pre_job
+    if: needs.pre_job.outputs.should_skip != 'true' && startsWith(github.head_ref, 'lint-fix-patches') == false && github.event.pull_request.head.repo.full_name == github.repository
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -62,6 +62,9 @@ jobs:
       - name: Verify h1 is present in every file
         run: node utils/js/h1_presence_checker.js
 
+      - name: Prepare data files for GPTs
+        run: node utils/js/create_data_for_gpts.js
+
       - name: Set lint-fix branch name
         id: vars
         shell: bash
@@ -128,7 +131,8 @@ jobs:
           ssh-key: ${{ secrets.DOCS_UI_SSH_PRIVATE_KEY }}
           repository: KomodoPlatform/website-komodo-docs
           ref: main
-          submodules: true
+          submodules: recursive
+          fetch-depth: 0
 
       - name: Get updated content (without diff)
         if: needs.update_lint_get_data.outputs.NO_DIFF == 'true'
@@ -180,7 +184,7 @@ jobs:
           accountId: ${{ secrets.CF_ACCOUNT_ID }}
           projectName: komodo-docs
           directory: ./out
-          #gitHubToken: ${{ secrets.GITHUB_TOKEN }}
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}
           wranglerVersion: "3"
           branch: ${{ steps.get_branch.outputs.BRANCH_NAME }}
 

STYLE_GUIDE.md

@@ -174,7 +174,7 @@ The `CodeGroup` acts as a wrapper around code blocks. It allows us to have tabbe
 
 And rendered as:
 
-![Code group UI](src/images/style-guide-images/code-group-sample.png)
+![Code group UI](style-guide-images/code-group-sample.png)
 
 <!-- If you have a single block of code, you can use the `CodeGroup` without wrapping it around the block by using `mdx-annotations`.
 
@@ -186,7 +186,7 @@ And rendered as:
 
 And you'll still have it rendered correctly:
 
-![Single code block UI](src/images/style-guide-images/single-code-block.png) -->
+![Single code block UI](style-guide-images/single-code-block.png) -->
 
 It is important to **note that**, "**AtomicDEX methods**" should be wrapped with `CodeGroup` tags, using the **method name** as the **label value**, and the **tag value** set to **POST**, an additional **mm2MethodDecorate property** with the value **"true"**. This will generate code blocks for:
 
@@ -223,7 +223,7 @@ A working code sample would look like this:
 
 Rendered as:
 
-![mm2MethodDecoratorUI](src/images/style-guide-images/mm2MethodDecoratorUI.png)
+![mm2MethodDecoratorUI](style-guide-images/mm2MethodDecoratorUI.png)
 
 ### Note
 
@@ -259,11 +259,11 @@ Use `Note` tags to **highlight important information**. `Note`s can be one of th
 
 Rendered as:
 
-![Note-info](src/images/style-guide-images/notes-info-UI.png)
+![Note-info](style-guide-images/notes-info-UI.png)
 
-![Note-warning](src/images/style-guide-images/notes-warning-UI.png)
+![Note-warning](style-guide-images/notes-warning-UI.png)
 
-![Note-error](src/images/style-guide-images/notes-error-UI.png)
+![Note-error](style-guide-images/notes-error-UI.png)
 
 ### CollapsibleSection
 
@@ -308,7 +308,7 @@ A working code would look like this:
 
 Rendered as:
 
-![collapsible Section UI](src/images/style-guide-images/collapsible-section-UI.png)
+![collapsible Section UI](style-guide-images/collapsible-section-UI.png)
 
 ### Images
 
@@ -320,7 +320,7 @@ Now you can render the image using the `OptimizedImage` component, for example:
 
 `<OptimizedImage title="Atomic Dex" src={atomicManiq} alt="atomic dex" classNaming="w-full" />`
 
-![Atomic Maniq](src/images/style-guide-images/atomic-maniq.png)
+![Atomic Maniq](style-guide-images/atomic-maniq.png)
 
 <!-- [You can read more about the magic behind OptimizedImage](https://github.com/Niels-IO/next-image-export-optimizer#readme) -->
 
@@ -348,7 +348,7 @@ Here's how:
 
 Rendered as:
 
-![heading tag UI](src/images/style-guide-images/heading-tag-UI.png)
+![heading tag UI](style-guide-images/heading-tag-UI.png)
 
 ### TaggedSection
 
@@ -366,7 +366,7 @@ Here's how to use it:
 
 Rendered as:
 
-![Tagged section](src/images/style-guide-images/tagged-section-UI.png)
+![Tagged section](style-guide-images/tagged-section-UI.png)
 
 ### Tag
 
@@ -389,17 +389,23 @@ A working code would look like this:
 
 Rendered as:
 
-![Tag component](src/images/style-guide-images/crude-tag-ui.png)
+![Tag component](style-guide-images/crude-tag-ui.png)
+
+## Navbar (Top)
+
+Top navbar's navigation data/dropdown list is manually populated. This file can be found at [src/data/navbar.json](src/data/navbar.json). If you're working on a very important new page, which links to a whole new category or an index, this is where to add them.
+
+![Navbar top](style-guide-images/navbar-top-UI.png)
 
 ## Sidebar (Left)
 
-Sidebar navigation is manually populated. This file can be found at `src/data/sidebar.json`. If you're working on a new page, this is where to link them.
+Left sidebar's navigation data is manually populated. This file can be found at [src/data/sidebar.json](src/data/sidebar.json). If you're working on a new page, this is where to link them.
 
-![Sidebar left](src/images/style-guide-images/sidebar-left-UI.png)
+![Sidebar left](style-guide-images/sidebar-left-UI.png)
 
 ## Sidebar (Right)
 
-![Sidebar right](src/images/style-guide-images/sidebar-right-UI.png)
+![Sidebar right](style-guide-images/sidebar-right-UI.png)
 
 The right sidebar is automatically populated based on the **Heading hierarchy** of the current page.