@ai-crew-suite/fixtures-techdocs 0.0.0-stage → 0.0.1

package/README.md

@@ -1,3 +1,82 @@
-# Temporary Holding Version
+# Mock Techdocs Fixtures
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+This package provides a default set of Techdocs documentation for the AI Crew Suite backend dev server. It packages source Markdown documents alongside pre-compiled HTML layouts and clientside full-text search indexes, allowing sandbox environments to serve realistic documentation tabs seamlessly for development and testing against a predictable baseline.
+
+## Local Development Workflow
+
+To initialize the monorepo workspace dependencies, run the following from the root directory:
+
+```bash
+yarn install
+```
+
+### Executing Static Data Lint Sweeps
+
+To evaluate the static TypeScript configurations against our workspace lint guidelines, execute:
+
+```bash
+yarn turbo run lint --filter=@ai-crew-suite/fixtures-techdocs
+```
+
+### Automated Code Style Fixing
+
+To automatically fix formatting errors, trailing spaces, or indentation variations inside your mock assets instantly, run:
+
+```bash
+yarn turbo run format --filter=@ai-crew-suite/fixtures-techdocs
+```
+
+### Typecheck
+
+To typecheck code, run:
+
+```bash
+yarn turbo run typecheck --filter=@ai-crew-suite/fixtures-techdocs
+```
+
+### Running the Test Suite
+
+To run isolated package validation checks and ensure entities conform to core schemas, execute:
+
+```bash
+yarn turbo run test:unit --filter=@ai-crew-suite/fixtures-techdocs
+```
+
+### Cleaning Old Compilation Build Arrays
+
+To wipe away legacy JavaScript modules and stale HTML asset caches, run:
+
+```bash
+yarn turbo run clean --filter=@ai-crew-suite/fixtures-techdocs
+```
+
+### Executing Unified Blueprint Compilation
+
+To trigger parallel compilation tasks (TypeScript code compilation and the underlying `techdocs-cli` wrapper compiler), run:
+
+```bash
+yarn turbo run build --filter=@ai-crew-suite/fixtures-techdocs
+```
+
+To build only the documentation, run:
+
+```bash
+yarn turbo run build:techdocs --filter=@ai-crew-suite/fixtures-techdocs
+```
+
+The build requires the Docker CLI and an accessible Docker-compatible engine.
+It uses `spotify/techdocs:latest` to run MkDocs and writes the generated site
+to `static-compiled/default/component/platform`. The TechDocs CLI prepares a
+temporary copy of the source, so its MkDocs configuration changes do not modify
+the checked-in files. Previous output is retained if generation fails.
+
+The container runs as its default user on rootless engines, where that user maps
+to the host user, and as the current UID and GID on rootful engines. MkDocs is
+run through the Docker CLI to avoid an intermittent Podman auto-removal race in
+the TechDocs CLI's Docker runner. The selected Docker context or `DOCKER_HOST`
+still controls which engine is used.
+
+## 📄 Compliance and Licensing
+
+Copyright © 2026 The AI Crew Suite Authors.
+Licensed under the **Apache License, Version 2.0**.

package/dist/__tests__/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/__tests__/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/index.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/index.test.js

@@ -0,0 +1,34 @@
+/**
+ * Copyright 2026 The AI Crew Suite Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { createRequire } from 'module';
+import path from 'path';
+import { afterEach, describe, expect, it, vi } from 'vitest';
+import { getProgrammaticTechDocsPath } from '../index';
+describe('Programmatic TechDocs asset resolution', () => {
+    afterEach(() => {
+        vi.unstubAllGlobals();
+    });
+    it('resolves the package asset directory when __dirname is unavailable', () => {
+        vi.stubGlobal('__dirname', undefined);
+        const assetPath = getProgrammaticTechDocsPath();
+        const packageRequire = createRequire(path.resolve(process.cwd(), 'package.json'));
+        const packageManifest = packageRequire.resolve('@ai-crew-suite/fixtures-techdocs/package.json');
+        const expectedPath = path.resolve(path.dirname(packageManifest), 'static-compiled');
+        expect(path.isAbsolute(assetPath)).toBe(true);
+        expect(assetPath).toBe(expectedPath);
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/__tests__/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../src/__tests__/index.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AACvC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,MAAM,UAAU,CAAC;AAEvD,QAAQ,CAAC,wCAAwC,EAAE,GAAG,EAAE;IACtD,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oEAAoE,EAAE,GAAG,EAAE;QAC5E,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QAEtC,MAAM,SAAS,GAAG,2BAA2B,EAAE,CAAC;QAChD,MAAM,cAAc,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;QAClF,MAAM,eAAe,GAAG,cAAc,CAAC,OAAO,CAAC,+CAA+C,CAAC,CAAC;QAChG,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,CAAC;QAEpF,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Returns the absolute filesystem resolution path pointing to the
+ * pre-compiled static HTML and search_index.json assets directory.
+ *
+ * Resolution starts at the consuming workspace so this works in CommonJS,
+ * ESM, workspace links, and installed packages without relying on `__dirname`.
+ */
+export declare function getProgrammaticTechDocsPath(): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAkBA;;;;;;GAMG;AACH,wBAAgB,2BAA2B,IAAI,MAAM,CAKpD"}

package/dist/index.js

@@ -0,0 +1,30 @@
+/**
+ * Copyright 2026 The AI Crew Suite Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { createRequire } from 'module';
+import path from 'path';
+/**
+ * Returns the absolute filesystem resolution path pointing to the
+ * pre-compiled static HTML and search_index.json assets directory.
+ *
+ * Resolution starts at the consuming workspace so this works in CommonJS,
+ * ESM, workspace links, and installed packages without relying on `__dirname`.
+ */
+export function getProgrammaticTechDocsPath() {
+    const packageRequire = createRequire(path.resolve(process.cwd(), 'package.json'));
+    const packageManifest = packageRequire.resolve('@ai-crew-suite/fixtures-techdocs/package.json');
+    return path.resolve(path.dirname(packageManifest), 'static-compiled');
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AACvC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB;;;;;;GAMG;AACH,MAAM,UAAU,2BAA2B;IACzC,MAAM,cAAc,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;IAClF,MAAM,eAAe,GAAG,cAAc,CAAC,OAAO,CAAC,+CAA+C,CAAC,CAAC;IAEhG,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,CAAC;AACxE,CAAC"}

package/package.json

@@ -1,6 +1,49 @@
 {
   "name": "@ai-crew-suite/fixtures-techdocs",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "description": "Pre-compiled programmatic TechDocs asset blueprints and search indexes for the AI Crew Suite dev server sandbox.",
+  "version": "0.0.1",
+  "license": "Apache-2.0",
+  "keywords": [
+    "agentic workflow",
+    "ai-crew-suite",
+    "backstage",
+    "techdocs",
+    "fixtures",
+    "documentation",
+    "search-index"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.js",
+  "files": [
+    "dist",
+    "static-compiled"
+  ],
+  "bugs": {
+    "url": "https://github.com/ai-crew-suite/workbench/issues",
+    "email": "support@ai-crew-suite.dev"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ai-crew-suite/workbench",
+    "directory": "packages/fixtures/techdocs"
+  },
+  "scripts": {
+    "build": "turbo run build:ts build:techdocs",
+    "build:ts": "tsc -b",
+    "build:techdocs": "./scripts/build-techdocs.sh",
+    "clean": "rimraf dist static-compiled",
+    "format": "backstage-cli crew format",
+    "lint": "backstage-cli crew lint",
+    "release": "npm publish --access public",
+    "test:unit": "backstage-cli crew test:unit",
+    "test:unit:coverage": "backstage-cli crew test:unit:coverage",
+    "typecheck": "backstage-cli crew typecheck"
+  },
+  "devDependencies": {
+    "@backstage/cli": "backstage:^",
+    "@techdocs/cli": "catalog:dev",
+    "rimraf": "catalog:dev",
+    "typescript": "catalog:dev",
+    "vitest": "catalog:dev"
+  }
+}

package/static-compiled/default/component/platform/404.html

@@ -0,0 +1,315 @@
+
+<!doctype html>
+<html lang="en" class="no-js">
+  <head>
+    
+      <meta charset="utf-8">
+      <meta name="viewport" content="width=device-width,initial-scale=1">
+      
+        <meta name="description" content="Technical baseline documentation architecture for the platform service layer.">
+      
+      
+      
+      
+      
+      
+        
+      
+      
+      <link rel="icon" href="/assets/images/favicon.png">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
+    
+    
+      
+        <title>AI Crew Suite Platform Documentation Core</title>
+      
+    
+    
+      <link rel="stylesheet" href="/assets/stylesheets/main.ec1eaa64.min.css">
+      
+      
+
+
+    
+    
+      
+    
+    
+      
+        
+        
+        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
+        <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
+      
+    
+    
+    <script>__md_scope=new URL("/",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    
+      
+
+    
+    
+  </head>
+  
+  
+    <body dir="ltr">
+  
+    
+    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+    <label class="md-overlay" for="__drawer"></label>
+    <div data-md-component="skip">
+      
+    </div>
+    <div data-md-component="announce">
+      
+    </div>
+    
+    
+      
+
+  
+
+<header class="md-header md-header--shadow" data-md-component="header">
+  <nav class="md-header__inner md-grid" aria-label="Header">
+    <a href="/." title="AI Crew Suite Platform Documentation Core" class="md-header__button md-logo" aria-label="AI Crew Suite Platform Documentation Core" data-md-component="logo">
+      
+  
+  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
+
+    </a>
+    <label class="md-header__button md-icon" for="__drawer">
+      
+      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
+    </label>
+    <div class="md-header__title" data-md-component="header-title">
+      <div class="md-header__ellipsis">
+        <div class="md-header__topic">
+          <span class="md-ellipsis">
+            AI Crew Suite Platform Documentation Core
+          </span>
+        </div>
+        <div class="md-header__topic" data-md-component="header-topic">
+          <span class="md-ellipsis">
+            
+              
+            
+          </span>
+        </div>
+      </div>
+    </div>
+    
+    
+    
+    
+      
+      
+        <label class="md-header__button md-icon" for="__search">
+          
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
+        </label>
+        <div class="md-search" data-md-component="search" role="dialog">
+  <label class="md-search__overlay" for="__search"></label>
+  <div class="md-search__inner" role="search">
+    <form class="md-search__form" name="search">
+      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
+      <label class="md-search__icon md-icon" for="__search">
+        
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
+        
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
+      </label>
+      <nav class="md-search__options" aria-label="Search">
+        
+        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
+          
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
+        </button>
+      </nav>
+      
+    </form>
+    <div class="md-search__output">
+      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
+        <div class="md-search-result" data-md-component="search-result">
+          <div class="md-search-result__meta">
+            Initializing search
+          </div>
+          <ol class="md-search-result__list" role="presentation"></ol>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+      
+    
+    
+  </nav>
+  
+</header>
+    
+    <div class="md-container" data-md-component="container">
+      
+      
+        
+          
+        
+      
+      <main class="md-main" data-md-component="main">
+        <div class="md-main__inner md-grid">
+          
+            
+              
+              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
+                <div class="md-sidebar__scrollwrap">
+                  <div class="md-sidebar__inner">
+                    
+
+
+
+<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
+  <label class="md-nav__title" for="__drawer">
+    <a href="/." title="AI Crew Suite Platform Documentation Core" class="md-nav__button md-logo" aria-label="AI Crew Suite Platform Documentation Core" data-md-component="logo">
+      
+  
+  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
+
+    </a>
+    AI Crew Suite Platform Documentation Core
+  </label>
+  
+  <ul class="md-nav__list" data-md-scrollfix>
+    
+      
+      
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="/." class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Home
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+    
+      
+      
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="/operations/" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Operations Manual
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+    
+  </ul>
+</nav>
+                  </div>
+                </div>
+              </div>
+            
+            
+              
+              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
+                <div class="md-sidebar__scrollwrap">
+                  <div class="md-sidebar__inner">
+                    
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+  
+  
+  
+  
+</nav>
+                  </div>
+                </div>
+              </div>
+            
+          
+          
+            <div class="md-content" data-md-component="content">
+              
+              <article class="md-content__inner md-typeset">
+                
+  <h1>404 - Not found</h1>
+
+              </article>
+            </div>
+          
+          
+<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
+        </div>
+        
+      </main>
+      
+        <footer class="md-footer">
+  
+    
+  
+  <div class="md-footer-meta md-typeset">
+    <div class="md-footer-meta__inner md-grid">
+      <div class="md-copyright">
+  
+  
+    Made with
+    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+      Material for MkDocs
+    </a>
+  
+</div>
+      
+    </div>
+  </div>
+</footer>
+      
+    </div>
+    <div class="md-dialog" data-md-component="dialog">
+      <div class="md-dialog__inner md-typeset"></div>
+    </div>
+    
+    
+    
+      
+      
+      <script id="__config" type="application/json">{"annotate": null, "base": "/", "features": ["navigation.footer", "content.action.edit"], "search": "/assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+    
+    
+      <script src="/assets/javascripts/bundle.d7400e89.min.js"></script>
+      
+        <script src="/search/main.js"></script>
+      
+    
+  </body>
+</html>