smithy-security · dlicheva · Sep 16, 2025 · Sep 16, 2025 · Sep 16, 2025
diff --git a/docs/reference/components/bandit.md b/docs/reference/components/bandit.md
@@ -1,9 +1,8 @@
 ---
 sidebar_custom_props:
-   icon: "/img/components/python-bandit.png"
+  icon: "/img/components/python-bandit.png"
 title: 'Bandit'
 description: 'SAST scanner that analyses Python source code to look for security issues.'
-sidebar_position: 3
 ---
 
 # Bandit

diff --git a/docs/reference/components/battlecard-printer.md b/docs/reference/components/battlecard-printer.md
@@ -3,7 +3,6 @@ sidebar_custom_props:
   icon: "/img/components/battlecard-printer.svg"
 title: 'Battlecard Printer'
 description: 'A reporter that prints a summary of items found during the scan'
-sidebar_position: 3
 ---
 
 # Battlecard Printer

diff --git a/docs/reference/components/cdxgen.md b/docs/reference/components/cdxgen.md
@@ -1,9 +1,8 @@
 ---
 sidebar_custom_props:
-    icon: "/img/components/cdxgen.svg"
+  icon: "/img/components/cdxgen.svg"
 title: 'CDXGen'
 description: 'Scanner component that generates a CycloneDX SBOM from source code.'
-sidebar_position: 5
 ---
 
 # CDXGEN
@@ -28,31 +27,31 @@ This component does not do anything else currently.
 description: Workflow scanning with cdxgen
 name: cdxgen
 components:
-- component: ghcr.io/smithy-security/smithy/manifests/components/targets/git-clone:v1.3.2
-- component: ghcr.io/smithy-security/smithy/manifests/components/scanners/cdxgen:v1.2.2
+  - component: ghcr.io/smithy-security/smithy/manifests/components/targets/git-clone:v1.3.2
+  - component: ghcr.io/smithy-security/smithy/manifests/components/scanners/cdxgen:v1.2.2
 ```
 
 2. Configure the run parameters of the component in the overrides file
 
 ```yaml
 # file: ./my-workflow/overrides.yaml
 git-clone:
-- name: "repo_url"
-  type: "string"
-  value: "https://github.com/sqreen/go-dvwa"
+  - name: "repo_url"
+    type: "string"
+    value: "https://github.com/sqreen/go-dvwa"
 cdxgen:
-- name: "backend_server_url"
-  type: "string"
-  value: ""
-- name: "api_key"
-  type: "string"
-  value: ""
-- name: "project_name"
-  type: "string"
-  value: ""
-- name: "project_version"
-  type: "string"
-  value: ""
+  - name: "backend_server_url"
+    type: "string"
+    value: ""
+  - name: "api_key"
+    type: "string"
+    value: ""
+  - name: "project_name"
+    type: "string"
+    value: ""
+  - name: "project_version"
+    type: "string"
+    value: ""
 ```
 
 ### SaaS

diff --git a/docs/reference/components/codeql.md b/docs/reference/components/codeql.md
@@ -1,9 +1,8 @@
 ---
 sidebar_custom_props:
-    icon: "/img/components/codeql.svg"
+  icon: "/img/components/codeql.svg"
 title: 'CodeQL'
 description: 'Scanner that runs Github CodeQL SAST.'
-sidebar_position: 5
 ---
 
 # CodeQL
@@ -22,24 +21,24 @@ The default CodeQL rules for each language are used to scan.
 description: Workflow scanning with codeql
 name: codeql
 components:
-- component: ghcr.io/smithy-security/smithy/manifests/components/targets/git-clone:v1.3.2
-- component: ghcr.io/smithy-security/smithy/manifests/components/scanners/codeql:v1.3.2
-- component: ghcr.io/smithy-security/smithy/manifests/components/scanners/nancy:v1.2.2
-- component: ghcr.io/smithy-security/smithy/manifests/components/enrichers/custom-annotation:v0.1.2
-- component: ghcr.io/smithy-security/smithy/manifests/components/reporters/json-logger:v1.0.2
+  - component: ghcr.io/smithy-security/smithy/manifests/components/targets/git-clone:v1.3.2
+  - component: ghcr.io/smithy-security/smithy/manifests/components/scanners/codeql:v1.3.2
+  - component: ghcr.io/smithy-security/smithy/manifests/components/scanners/nancy:v1.2.2
+  - component: ghcr.io/smithy-security/smithy/manifests/components/enrichers/custom-annotation:v0.1.2
+  - component: ghcr.io/smithy-security/smithy/manifests/components/reporters/json-logger:v1.0.2
 ```
 
 2. Configure the run parameters of the component in the overrides file
 
 ```yaml
 # file: ./my-workflow/overrides.yaml
 git-clone:
-- name: "repo_url"
-  type: "string"
-  value: "https://github.com/0c34/govwa.git"
-- name: "reference"
-  type: "string"
-  value: "master"
+  - name: "repo_url"
+    type: "string"
+    value: "https://github.com/0c34/govwa.git"
+  - name: "reference"
+    type: "string"
+    value: "master"
 ```
 
 ### SaaS

diff --git a/docs/reference/components/credo.md b/docs/reference/components/credo.md
@@ -3,7 +3,6 @@ sidebar_custom_props:
   icon: "/img/components/credo.svg"
 title: 'Credo'
 description: 'Elixir static code analysis with Credo.'
-sidebar_position: 3
 ---
 
 # Credo

diff --git a/docs/reference/components/custom-annotation.md b/docs/reference/components/custom-annotation.md
@@ -1,9 +1,8 @@
 ---
 sidebar_custom_props:
-    icon: "/img/components/smithy.svg"
+  icon: "/img/components/smithy.svg"
 title: 'Custom Annotation'
 description: 'Enricher component that adds a custom annotation to findings. Mainly used for testing.'
-sidebar_position: 16
 ---
 
 # Custom Annotation

diff --git a/docs/reference/components/data-enricher-frontend.md b/docs/reference/components/data-enricher-frontend.md
@@ -3,7 +3,6 @@ sidebar_custom_props:
   icon: "/img/components/smithy.svg"
 title: "Data Enricher"
 description: "Enricher component that adds details and deduplicates issues."
-sidebar_position: 16
 ---
 
 # Data Enricher - deduplication

diff --git a/docs/reference/components/defect-dojo.md b/docs/reference/components/defect-dojo.md
@@ -3,7 +3,6 @@ sidebar_custom_props:
   icon: "/img/components/defectdojo.svg"
 title: 'Defect Dojo'
 description: 'Reporter that pushes findings to a DefectDojo instance.'
-sidebar_position: 18
 ---
 
 # Defect Dojo

diff --git a/docs/reference/components/discord.md b/docs/reference/components/discord.md
@@ -1,9 +1,8 @@
 ---
 sidebar_custom_props:
-    icon: "/img/components/discord.svg"
+  icon: "/img/components/discord.svg"
 title: 'Discord'
 description: 'Discord reporter that sends messages to Discord.'
-sidebar_position: 17
 ---
 
 # Discord

diff --git a/docs/reference/components/elasticsearch.md b/docs/reference/components/elasticsearch.md
@@ -1,9 +1,8 @@
 ---
 sidebar_custom_props:
-   icon: "/img/components/elasticsearch.svg"
+  icon: "/img/components/elasticsearch.svg"
 title: 'ElasticSearch'
 description: 'Reporter that pushes findings to an ElasticSearch instance.'
-sidebar_position: 14
 ---
 
 # ElasticSearch
@@ -22,11 +21,11 @@ about ElasticSearch [here](https://kagi.com/search?q=elasticsearch).
 description: Workflow reporting to elasticsearch
 name: elasticsearch
 components:
-- component: ghcr.io/smithy-security/smithy/manifests/components/targets/git-clone:v1.3.2
-- component: ghcr.io/smithy-security/smithy/manifests/components/scanners/gosec:v1.2.3
-- component: ghcr.io/smithy-security/smithy/manifests/components/scanners/nancy:v1.2.2
-- component: ghcr.io/smithy-security/smithy/manifests/components/enrichers/custom-annotation:v0.1.2
-- component: ghcr.io/smithy-security/smithy/manifests/components/reporters/elasticsearch:v1.0.1
+  - component: ghcr.io/smithy-security/smithy/manifests/components/targets/git-clone:v1.3.2
+  - component: ghcr.io/smithy-security/smithy/manifests/components/scanners/gosec:v1.2.3
+  - component: ghcr.io/smithy-security/smithy/manifests/components/scanners/nancy:v1.2.2
+  - component: ghcr.io/smithy-security/smithy/manifests/components/enrichers/custom-annotation:v0.1.2
+  - component: ghcr.io/smithy-security/smithy/manifests/components/reporters/elasticsearch:v1.0.1
 
 ```
 
@@ -36,22 +35,22 @@ components:
 ```yaml
 # file: ./my-workflow/overrides.yaml
 git-clone:
-- name: "repo_url"
-  type: "string"
-  value: "https://github.com/sqreen/go-dvwa"
-- name: "reference"
-  type: "string"
-  value: "master"
+  - name: "repo_url"
+    type: "string"
+    value: "https://github.com/sqreen/go-dvwa"
+  - name: "reference"
+    type: "string"
+    value: "master"
 elasticsearch:
-- name: "elasticsearch_url"
-  type: "string"
-  value: "Your ES URL here"
-- name: "elasticsearch_index"
-  type: "string"
-  value: "Any Index"
-- name: "elasticsearch_api_key"
-  type: "string"
-  value: "An API Key with the rights to read cluster and write indexes"
+  - name: "elasticsearch_url"
+    type: "string"
+    value: "Your ES URL here"
+  - name: "elasticsearch_index"
+    type: "string"
+    value: "Any Index"
+  - name: "elasticsearch_api_key"
+    type: "string"
+    value: "An API Key with the rights to read cluster and write indexes"
 ```
 
 *Warning*: You need to configure secrets and other parameters for elasticsearch

diff --git a/docs/reference/components/exploit-exists.md b/docs/reference/components/exploit-exists.md
@@ -1,9 +1,8 @@
 ---
 sidebar_custom_props:
-    icon: "/img/components/smithy.svg"
+  icon: "/img/components/smithy.svg"
 title: 'Exploit Finder'
 description: 'SaaS-Only Enricher component that adds an annotation and a filter if it can find an exploit for the given CVE'
-sidebar_position: 16
 ---
 
 # Exploit Finder

diff --git a/docs/reference/components/git-clone.md b/docs/reference/components/git-clone.md
@@ -3,7 +3,6 @@ sidebar_custom_props:
   icon: "/img/components/git-clone.svg"
 title: 'Git Clone'
 description: 'Source component that shallow clones a repository for scanning'
-sidebar_position: 1
 ---
 
 # Git Clone

diff --git a/docs/reference/components/git-intel-enricher.md b/docs/reference/components/git-intel-enricher.md
@@ -3,7 +3,6 @@ sidebar_custom_props:
   icon: "/img/components/github.svg"
 title: 'Git Intelligence Enricher'
 description: 'Enricher component adds Git Intelligence Enrichments to findings, so they can be better deduplicated.'
-sidebar_position: 19
 ---
 
 # Git Intelligence Enricher

diff --git a/docs/reference/components/github-pr-commenter.md b/docs/reference/components/github-pr-commenter.md
@@ -3,7 +3,6 @@ sidebar_custom_props:
   icon: "/img/components/github.svg"
 title: 'GitHub PR Commenter'
 description: 'Reporter that comments on GitHub PRs with findings in changed lines.'
-sidebar_position: 15
 ---
 
 # GitHub PR Commenter

diff --git a/docs/reference/components/gosec.md b/docs/reference/components/gosec.md
@@ -1,9 +1,8 @@
 ---
 sidebar_custom_props:
-    icon: "/img/components/golang-gosec.png"
+  icon: "/img/components/golang-gosec.png"
 title: 'Gosec'
 description: 'Scanner that runs the Gosec SAST for Go.'
-sidebar_position: 5
 ---
 
 # Gosec
@@ -19,24 +18,24 @@ This scanner component runs the popular open source SAST Gosec.
 description: Workflow scanning with gosec
 name: gosec
 components:
-- component: ghcr.io/smithy-security/smithy/manifests/components/targets/git-clone:v1.3.2
-- component: ghcr.io/smithy-security/smithy/manifests/components/scanners/gosec:v1.2.3
-- component: ghcr.io/smithy-security/smithy/manifests/components/scanners/nancy:v1.2.2
-- component: ghcr.io/smithy-security/smithy/manifests/components/enrichers/custom-annotation:v0.1.2
-- component: ghcr.io/smithy-security/smithy/manifests/components/reporters/json-logger:v1.0.2
+  - component: ghcr.io/smithy-security/smithy/manifests/components/targets/git-clone:v1.3.2
+  - component: ghcr.io/smithy-security/smithy/manifests/components/scanners/gosec:v1.2.3
+  - component: ghcr.io/smithy-security/smithy/manifests/components/scanners/nancy:v1.2.2
+  - component: ghcr.io/smithy-security/smithy/manifests/components/enrichers/custom-annotation:v0.1.2
+  - component: ghcr.io/smithy-security/smithy/manifests/components/reporters/json-logger:v1.0.2
 ```
 
 2. Configure the run parameters of the component in the overrides file
 
 ```yaml
 # file: ./my-workflow/overrides.yaml
 git-clone:
-- name: "repo_url"
-  type: "string"
-  value: "https://github.com/0c34/govwa.git"
-- name: "reference"
-  type: "string"
-  value: "master"
+  - name: "repo_url"
+    type: "string"
+    value: "https://github.com/0c34/govwa.git"
+  - name: "reference"
+    type: "string"
+    value: "master"
 ```
 
 ### SaaS

diff --git a/docs/reference/components/image-get.md b/docs/reference/components/image-get.md
@@ -1,9 +1,8 @@
 ---
 sidebar_custom_props:
-   icon: "/img/components/image-get.svg"
+  icon: "/img/components/image-get.svg"
 title: 'Image Get'
 description: 'Source component that downloads a remote (OCI) container image for scanning'
-sidebar_position: 1
 ---
 
 # Image Get

diff --git a/docs/reference/components/jira.md b/docs/reference/components/jira.md
@@ -1,9 +1,8 @@
 ---
 sidebar_custom_props:
-    icon: "/img/components/jira.svg"
+  icon: "/img/components/jira.svg"
 title: 'Jira'
 description: 'Jira reporter that opens formatted issues for every non-filtered finding.'
-sidebar_position: 17
 ---
 
 # Jira

diff --git a/docs/reference/components/json-logger.md b/docs/reference/components/json-logger.md
@@ -1,9 +1,8 @@
 ---
 sidebar_custom_props:
-    icon: "/img/components/stdout-json.svg"
+  icon: "/img/components/stdout-json.svg"
 title: 'JSON Logger'
 description: 'Reporter component that prints findings to stdout in JSON format.'
-sidebar_position: 16
 ---
 
 # JSON Logger