docs: add overlay testing documentation section (#25)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>

Author: subhashkhileri

docs/.vitepress/config.ts

@@ -31,6 +31,7 @@ export default defineConfig({
       { text: "API Reference", link: "/api/" },
       { text: "Tutorials", link: "/tutorials/" },
       { text: "Examples", link: "/examples/" },
+      { text: "Overlay Testing", link: "/overlay/" },
       {
         text: "v1.1.6",
         items: [{ text: "Changelog", link: "/changelog" }],
@@ -308,6 +309,91 @@ export default defineConfig({
           ],
         },
       ],
+
+      "/overlay/": [
+        {
+          text: "Overlay Testing",
+          items: [
+            { text: "Overview", link: "/overlay/" },
+            { text: "Getting Started", link: "/overlay/getting-started" },
+            {
+              text: "Repository Structure",
+              link: "/overlay/repository-structure",
+            },
+          ],
+        },
+        {
+          text: "Test Structure",
+          collapsed: false,
+          items: [
+            {
+              text: "Directory Layout",
+              link: "/overlay/test-structure/directory-layout",
+            },
+            {
+              text: "Configuration Files",
+              link: "/overlay/test-structure/configuration-files",
+            },
+            { text: "Spec Files", link: "/overlay/test-structure/spec-files" },
+          ],
+        },
+        {
+          text: "Tutorials",
+          collapsed: false,
+          items: [
+            {
+              text: "Adding Tests to New Workspace",
+              link: "/overlay/tutorials/new-workspace",
+            },
+            {
+              text: "Plugin Configuration",
+              link: "/overlay/tutorials/plugin-config",
+            },
+            {
+              text: "Pre-requisite Services",
+              link: "/overlay/tutorials/custom-deployment",
+            },
+            {
+              text: "Running Tests Locally",
+              link: "/overlay/tutorials/running-locally",
+            },
+            { text: "CI/CD Pipeline", link: "/overlay/tutorials/ci-pipeline" },
+          ],
+        },
+        {
+          text: "Examples",
+          collapsed: false,
+          items: [
+            {
+              text: "Tech Radar Plugin",
+              link: "/overlay/examples/tech-radar",
+            },
+            {
+              text: "Basic Plugin Test",
+              link: "/overlay/examples/basic-plugin",
+            },
+          ],
+        },
+        {
+          text: "Reference",
+          collapsed: true,
+          items: [
+            {
+              text: "Environment Variables",
+              link: "/overlay/reference/environment-variables",
+            },
+            {
+              text: "Package.json Scripts",
+              link: "/overlay/reference/scripts",
+            },
+            { text: "Common Patterns", link: "/overlay/reference/patterns" },
+            {
+              text: "Troubleshooting",
+              link: "/overlay/reference/troubleshooting",
+            },
+          ],
+        },
+      ],
     },
 
     socialLinks: [

docs/guide/index.md

@@ -72,3 +72,7 @@ The package simplifies end-to-end testing for RHDH plugins by providing:
 2. [Quick Start](/guide/quick-start) - Create your first E2E test
 3. [Requirements](/guide/requirements) - System and cluster requirements
 4. [Core Concepts](/guide/core-concepts/) - Understand the key concepts
+
+::: tip For Overlay Repository Contributors
+If you're writing tests in the **rhdh-plugin-export-overlays** repository, see the [Overlay Testing](/overlay/) documentation for repository-specific guidance including CI/CD integration, Vault secrets, and workspace structure.
+:::

docs/guide/utilities/plugin-metadata.md

@@ -178,3 +178,7 @@ See [Environment Variables](/guide/configuration/environment-variables#plugin-me
 ## API Reference
 
 For complete API documentation, see [Plugin Metadata API](/api/utils/plugin-metadata).
+
+::: tip For Overlay Repository
+If you're writing tests in the **rhdh-plugin-export-overlays** repository, see [Overlay Configuration Files](/overlay/test-structure/configuration-files) for how plugin metadata and OCI URL generation work in that context.
+:::

docs/index.md

@@ -13,8 +13,8 @@ hero:
       text: API Reference
       link: /api/
     - theme: alt
-      text: View on GitHub
-      link: https://github.com/redhat-developer/rhdh-e2e-test-utils
+      text: Overlay Testing
+      link: /overlay/
 
 features:
   - icon: 🚀
@@ -35,6 +35,9 @@ features:
   - icon: ⚙️
     title: Configuration Tools
     details: ESLint configuration factory with Playwright best practices and TypeScript base configuration.
+  - icon: 🔧
+    title: Overlay Repository Support
+    details: Dedicated documentation for writing E2E tests in the rhdh-plugin-export-overlays repository.
 ---
 
 ## Quick Example
@@ -82,3 +85,4 @@ test("verify catalog", async ({ uiHelper }) => {
 - [Installation](/guide/installation) - Install the package
 - [Quick Start](/guide/quick-start) - Create your first test
 - [API Reference](/api/) - Explore the full API
+- [Overlay Testing](/overlay/) - For tests in rhdh-plugin-export-overlays