@x12i/connectix-docs 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +77 -0
- package/bin/connectix-docs.js +2 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +56 -0
- package/dist/cli.js.map +1 -0
- package/dist/generated/bundle.d.ts +7 -0
- package/dist/generated/bundle.d.ts.map +1 -0
- package/dist/generated/bundle.js +304 -0
- package/dist/generated/bundle.js.map +1 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +13 -0
- package/dist/index.js.map +1 -0
- package/dist/web/.deploy-ready +1 -0
- package/dist/web/agent-manifest.json +102 -0
- package/dist/web/agents.html +66 -0
- package/dist/web/app.js +164 -0
- package/dist/web/assets/book.css +783 -0
- package/dist/web/assets/extras.css +137 -0
- package/dist/web/assets/site.css +792 -0
- package/dist/web/assets/tokens.css +19 -0
- package/dist/web/books/00-orient-connectix/developers.html +174 -0
- package/dist/web/books/00-orient-connectix.html +56 -0
- package/dist/web/books/01-tools-and-simulator/developers.html +197 -0
- package/dist/web/books/01-tools-and-simulator.html +56 -0
- package/dist/web/catalog.html +83 -0
- package/dist/web/catalog.json +59 -0
- package/dist/web/docs.html +73 -0
- package/dist/web/downloads/books/00-orient-connectix/developers.chapters.json +26 -0
- package/dist/web/downloads/books/00-orient-connectix/developers.md +82 -0
- package/dist/web/downloads/books/01-tools-and-simulator/developers.chapters.json +32 -0
- package/dist/web/downloads/books/01-tools-and-simulator/developers.md +118 -0
- package/dist/web/downloads/use-cases/call-connect-tools.md +78 -0
- package/dist/web/downloads/use-cases/catalog-extension-overview.md +42 -0
- package/dist/web/downloads/use-cases/orient-connectix.md +95 -0
- package/dist/web/downloads/use-cases/run-package-simulator.md +48 -0
- package/dist/web/getting-started.html +74 -0
- package/dist/web/index.html +84 -0
- package/dist/web/pages.json +55 -0
- package/dist/web/read.html +121 -0
- package/dist/web/site.json +28 -0
- package/dist/web/use-cases.html +66 -0
- package/dist/web/use-cases.json +103 -0
- package/package.json +64 -0
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
|
+
<title>Getting started</title>
|
|
7
|
+
<link rel="preconnect" href="https://fonts.googleapis.com">
|
|
8
|
+
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@400;500;600;700&family=IBM+Plex+Mono:wght@400;500;600&display=swap" rel="stylesheet">
|
|
9
|
+
<link rel="stylesheet" href="/assets/site.css">
|
|
10
|
+
<link rel="stylesheet" href="/assets/extras.css">
|
|
11
|
+
</head>
|
|
12
|
+
<body class="page-getting-started" style="--accent:#2f6feb;--accent-alt:#1f6e5c" data-page="getting-started">
|
|
13
|
+
<div class="page-shell">
|
|
14
|
+
<header class="site-header">
|
|
15
|
+
<a class="brand" href="/docs">
|
|
16
|
+
<span class="brand-mark" aria-hidden="true"></span>
|
|
17
|
+
<span class="brand-name">connectix</span>
|
|
18
|
+
<span class="brand-badge">docs</span>
|
|
19
|
+
</a>
|
|
20
|
+
<button type="button" class="nav-toggle" aria-label="Menu" data-nav-toggle>Menu</button>
|
|
21
|
+
<nav class="site-nav" data-site-nav>
|
|
22
|
+
<a href="/getting-started">Getting started</a><a href="/use-cases">Use cases</a><a href="/catalog">Catalog</a><a href="/agents">Agents/SDK</a>
|
|
23
|
+
|
|
24
|
+
</nav>
|
|
25
|
+
</header>
|
|
26
|
+
<main>
|
|
27
|
+
<section class="hero">
|
|
28
|
+
<div class="hero-kicker">Start here</div>
|
|
29
|
+
<h1>Get oriented on Connectix</h1>
|
|
30
|
+
<p class="hero-lead">Read the ownership boundaries, then call the four curated operations from a typed client, AI tools, or the package simulator.</p>
|
|
31
|
+
<div class="cta-row"><a class="btn btn-primary" href="/books/00-orient-connectix">Orient on Connectix</a><a class="btn btn-secondary" href="/books/01-tools-and-simulator">Tools & simulator</a></div>
|
|
32
|
+
</section>
|
|
33
|
+
<section class="install-callout" aria-label="Install knowledge package">
|
|
34
|
+
<div class="install-callout-inner">
|
|
35
|
+
<div class="install-kicker">npm</div>
|
|
36
|
+
<h2 class="install-title">Install for agents & tooling</h2>
|
|
37
|
+
<p class="install-lead">Knowledge SDK — install as a <strong>devDependency</strong> only (not a production runtime).</p>
|
|
38
|
+
<pre class="install-cmd install-cmd-primary"><code>npm i -D @x12i/connectix-docs</code></pre>
|
|
39
|
+
<div class="install-cmd-label">Knowledge SDK</div><pre class="install-cmd"><code>npm i -D @x12i/connectix-docs</code></pre><div class="install-cmd-label">Tools</div><pre class="install-cmd"><code>npm i @x12i/connectix-tools</code></pre><div class="install-cmd-label">Simulator</div><pre class="install-cmd"><code>npm i -D @x12i/connectix-simulator</code></pre>
|
|
40
|
+
<p class="install-more"><a href="/agents">Agents / SDK details →</a> · <a href="/agent-manifest.json">agent-manifest.json</a></p>
|
|
41
|
+
</div>
|
|
42
|
+
</section>
|
|
43
|
+
<section class="section tracks"><div class="track track-main">
|
|
44
|
+
<div class="tag ">Call Connectix</div>
|
|
45
|
+
<ol class="step-list"><li><span class="step-num">1</span><span class="step-text">Install @x12i/connectix-client or @x12i/connectix-tools</span></li><li><span class="step-num">2</span><span class="step-text">Pass Authorization + x-connectix-caller-id headers</span></li><li><span class="step-num">3</span><span class="step-text">Discover → describe → execute (stub first)</span></li></ol>
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
</div><div class="track track-alt">
|
|
49
|
+
<div class="tag tag-alt">Develop locally</div>
|
|
50
|
+
<ol class="step-list"><li><span class="step-num">1</span><span class="step-text">Install @x12i/connectix-simulator as a devDependency</span></li><li><span class="step-num">2</span><span class="step-text">Run tools against createSimulatorPipelineCaller()</span></li><li><span class="step-num">3</span><span class="step-text">Switch baseUrl to the live service when ready</span></li></ol>
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
</div></section>
|
|
54
|
+
<section class="section prose"><p>Start in stub mode. Live execution leases credentials via Credorix and is opt-in per request.</p>
|
|
55
|
+
</section>
|
|
56
|
+
</main>
|
|
57
|
+
<footer class="site-footer">
|
|
58
|
+
<div class="footer-id">Connectix — internal X12I provider connectivity service.</div>
|
|
59
|
+
<nav class="footer-nav">
|
|
60
|
+
<a href="/docs">Docs home</a><a href="/getting-started">Getting started</a><a href="/use-cases">Use cases</a><a href="/catalog">Catalog</a><a href="/agents">Agents/SDK</a>
|
|
61
|
+
</nav>
|
|
62
|
+
</footer>
|
|
63
|
+
</div>
|
|
64
|
+
|
|
65
|
+
<script>
|
|
66
|
+
document.querySelectorAll("[data-nav-toggle]").forEach((btn) => {
|
|
67
|
+
btn.addEventListener("click", () => {
|
|
68
|
+
document.querySelector("[data-site-nav]")?.classList.toggle("open");
|
|
69
|
+
});
|
|
70
|
+
});
|
|
71
|
+
</script>
|
|
72
|
+
|
|
73
|
+
</body>
|
|
74
|
+
</html>
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
|
+
<title>Connectix</title>
|
|
7
|
+
<link rel="preconnect" href="https://fonts.googleapis.com">
|
|
8
|
+
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@400;500;600;700&family=IBM+Plex+Mono:wght@400;500;600&display=swap" rel="stylesheet">
|
|
9
|
+
<link rel="stylesheet" href="/assets/site.css">
|
|
10
|
+
<link rel="stylesheet" href="/assets/extras.css">
|
|
11
|
+
</head>
|
|
12
|
+
<body class="page-product-home" style="--accent:#2f6feb;--accent-alt:#1f6e5c" data-page="product-home">
|
|
13
|
+
<div class="page-shell">
|
|
14
|
+
<header class="site-header">
|
|
15
|
+
<a class="brand" href="/">
|
|
16
|
+
<span class="brand-mark" aria-hidden="true"></span>
|
|
17
|
+
<span class="brand-name">connectix</span>
|
|
18
|
+
|
|
19
|
+
</a>
|
|
20
|
+
<button type="button" class="nav-toggle" aria-label="Menu" data-nav-toggle>Menu</button>
|
|
21
|
+
<nav class="site-nav" data-site-nav>
|
|
22
|
+
<a href="/#product">Product</a><a href="/docs">Docs</a>
|
|
23
|
+
<a class="btn btn-primary btn-sm" href="/docs">Read the docs →</a>
|
|
24
|
+
</nav>
|
|
25
|
+
</header>
|
|
26
|
+
<main>
|
|
27
|
+
<section class="hero">
|
|
28
|
+
<div class="hero-kicker">X12I connectivity</div>
|
|
29
|
+
<h1>Connectix</h1>
|
|
30
|
+
<p class="hero-lead">Internal provider connectivity for AI Skills, FuncX, and Memorix Pipeline Services — curated actions, bindings instead of secrets, stub or live.</p>
|
|
31
|
+
<div class="cta-row"><a class="btn btn-primary" href="/docs">Read the docs</a><a class="btn btn-secondary" href="/use-cases">Browse use cases</a></div>
|
|
32
|
+
</section>
|
|
33
|
+
<section class="install-callout" aria-label="Install knowledge package">
|
|
34
|
+
<div class="install-callout-inner">
|
|
35
|
+
<div class="install-kicker">npm</div>
|
|
36
|
+
<h2 class="install-title">Install for agents & tooling</h2>
|
|
37
|
+
<p class="install-lead">Knowledge SDK only — never a production dependency.</p>
|
|
38
|
+
<pre class="install-cmd install-cmd-primary"><code>npm i -D @x12i/connectix-docs</code></pre>
|
|
39
|
+
|
|
40
|
+
<p class="install-more"><a href="/agents">Agents / SDK details →</a> · <a href="/agent-manifest.json">agent-manifest.json</a></p>
|
|
41
|
+
</div>
|
|
42
|
+
</section>
|
|
43
|
+
<section class="section" id="product">
|
|
44
|
+
<h2 class="section-kicker">What callers get</h2>
|
|
45
|
+
<div class="grid-cells"><div class="grid-cell"><div class="cell-title">Four curated operations</div><div class="cell-body">listProviders, searchActions, getAction, executeAction — never the full upstream catalog as LLM tools.</div></div><div class="grid-cell"><div class="cell-title">Binding-first auth</div><div class="cell-body">Callers pass a bindingRef. Credorix owns secrets; Memorix owns bindings and execution records.</div></div><div class="grid-cell"><div class="cell-title">Package simulator</div><div class="cell-body">@x12i/connectix-simulator mirrors /health, /metadata, /v1/*, and /pipeline with deterministic stub fixtures.</div></div><div class="grid-cell"><div class="cell-title">AI tool definitions</div><div class="cell-body">@x12i/connectix-tools ships JSON Schema tool defs and runners that work against the service or the simulator.</div></div></div>
|
|
46
|
+
</section>
|
|
47
|
+
<section class="section">
|
|
48
|
+
<div class="section-head">
|
|
49
|
+
<h2>Field guides</h2>
|
|
50
|
+
<a class="section-link" href="/catalog">View full catalog →</a>
|
|
51
|
+
</div>
|
|
52
|
+
<div class="book-card-grid"><a class="book-card" href="/books/00-orient-connectix">
|
|
53
|
+
<span class="book-num">Book 00</span>
|
|
54
|
+
<span class="book-title">Orient on Connectix</span>
|
|
55
|
+
<span class="tag-row"><span class="tag">Dev</span></span>
|
|
56
|
+
</a><a class="book-card" href="/books/01-tools-and-simulator">
|
|
57
|
+
<span class="book-num">Book 01</span>
|
|
58
|
+
<span class="book-title">AI Tools and the Package Simulator</span>
|
|
59
|
+
<span class="tag-row"><span class="tag">Dev</span></span>
|
|
60
|
+
</a></div>
|
|
61
|
+
</section>
|
|
62
|
+
<section class="section prose"><p>Connectix is the internal X12I provider connectivity service. It sits between approved
|
|
63
|
+
callers and external provider APIs, selecting connections via non-secret bindings and
|
|
64
|
+
leasing credentials from Credorix.</p>
|
|
65
|
+
</section>
|
|
66
|
+
</main>
|
|
67
|
+
<footer class="site-footer">
|
|
68
|
+
<div class="footer-id">Connectix — internal X12I provider connectivity service.</div>
|
|
69
|
+
<nav class="footer-nav">
|
|
70
|
+
<a href="/docs">Docs home</a><a href="/getting-started">Getting started</a><a href="/use-cases">Use cases</a><a href="/catalog">Catalog</a><a href="/agents">Agents/SDK</a>
|
|
71
|
+
</nav>
|
|
72
|
+
</footer>
|
|
73
|
+
</div>
|
|
74
|
+
|
|
75
|
+
<script>
|
|
76
|
+
document.querySelectorAll("[data-nav-toggle]").forEach((btn) => {
|
|
77
|
+
btn.addEventListener("click", () => {
|
|
78
|
+
document.querySelector("[data-site-nav]")?.classList.toggle("open");
|
|
79
|
+
});
|
|
80
|
+
});
|
|
81
|
+
</script>
|
|
82
|
+
|
|
83
|
+
</body>
|
|
84
|
+
</html>
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 1,
|
|
3
|
+
"pages": [
|
|
4
|
+
{
|
|
5
|
+
"page": "agents",
|
|
6
|
+
"route": "/agents",
|
|
7
|
+
"file": "agents.html",
|
|
8
|
+
"title": "Agents & SDK"
|
|
9
|
+
},
|
|
10
|
+
{
|
|
11
|
+
"page": "catalog",
|
|
12
|
+
"route": "/catalog",
|
|
13
|
+
"file": "catalog.html",
|
|
14
|
+
"title": "Catalog"
|
|
15
|
+
},
|
|
16
|
+
{
|
|
17
|
+
"page": "docs-home",
|
|
18
|
+
"route": "/docs",
|
|
19
|
+
"file": "docs.html",
|
|
20
|
+
"title": "Connectix docs"
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
"page": "getting-started",
|
|
24
|
+
"route": "/getting-started",
|
|
25
|
+
"file": "getting-started.html",
|
|
26
|
+
"title": "Getting started"
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"page": "product-home",
|
|
30
|
+
"route": "/",
|
|
31
|
+
"file": "index.html",
|
|
32
|
+
"title": "Connectix"
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"page": "use-cases",
|
|
36
|
+
"route": "/use-cases",
|
|
37
|
+
"file": "use-cases.html",
|
|
38
|
+
"title": "Use cases"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"page": "book-landing",
|
|
42
|
+
"route": "/books/00-orient-connectix",
|
|
43
|
+
"file": "books/00-orient-connectix.html",
|
|
44
|
+
"title": "Orient on Connectix",
|
|
45
|
+
"bookId": "00-orient-connectix"
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"page": "book-landing",
|
|
49
|
+
"route": "/books/01-tools-and-simulator",
|
|
50
|
+
"file": "books/01-tools-and-simulator.html",
|
|
51
|
+
"title": "AI Tools and the Package Simulator",
|
|
52
|
+
"bookId": "01-tools-and-simulator"
|
|
53
|
+
}
|
|
54
|
+
]
|
|
55
|
+
}
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
|
+
<title>Reader</title>
|
|
7
|
+
<link rel="preconnect" href="https://fonts.googleapis.com">
|
|
8
|
+
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@400;500;600;700&family=IBM+Plex+Mono:wght@400;500;600&display=swap" rel="stylesheet">
|
|
9
|
+
<link rel="stylesheet" href="/assets/site.css">
|
|
10
|
+
<link rel="stylesheet" href="/assets/extras.css">
|
|
11
|
+
<style>
|
|
12
|
+
body{ height: 100vh; overflow: hidden; display:flex; flex-direction:column; }
|
|
13
|
+
main{ display:flex; flex-direction:column; flex:1; min-height:0; }
|
|
14
|
+
</style>
|
|
15
|
+
</head>
|
|
16
|
+
<body>
|
|
17
|
+
<div id="topbar-slot"></div>
|
|
18
|
+
<button class="sidebar-toggle" id="toggle">Chapters</button>
|
|
19
|
+
<main>
|
|
20
|
+
<div class="reader-shell" style="flex:1;min-height:0;">
|
|
21
|
+
<aside class="reader-sidebar" id="sidebar"></aside>
|
|
22
|
+
<div class="reader-main">
|
|
23
|
+
<div class="reader-topline" id="topline"></div>
|
|
24
|
+
<div class="reader-frame-wrap">
|
|
25
|
+
<iframe id="frame" title="Book content"></iframe>
|
|
26
|
+
</div>
|
|
27
|
+
</div>
|
|
28
|
+
</div>
|
|
29
|
+
</main>
|
|
30
|
+
<script src="/app.js"></script>
|
|
31
|
+
<script>
|
|
32
|
+
const bookId = qs("book");
|
|
33
|
+
const role = qs("role") || "developers";
|
|
34
|
+
const hashChapter = location.hash.replace(/^#/, "");
|
|
35
|
+
|
|
36
|
+
document.getElementById("toggle").onclick = () => {
|
|
37
|
+
document.getElementById("sidebar").classList.toggle("open");
|
|
38
|
+
};
|
|
39
|
+
|
|
40
|
+
Promise.all([loadCatalog(), loadSite(), loadJson("/agent-manifest.json")]).then(([catalog, site, manifest]) => {
|
|
41
|
+
const book = catalog.books.find((b) => b.id === bookId);
|
|
42
|
+
if (!book) {
|
|
43
|
+
document.getElementById("sidebar").innerHTML = `<div class="side-block"><p>Book not found.</p></div>`;
|
|
44
|
+
return;
|
|
45
|
+
}
|
|
46
|
+
if (site.accent) document.body.style.setProperty("--accent", site.accent);
|
|
47
|
+
if (site.accentAlt) document.body.style.setProperty("--accent-alt", site.accentAlt);
|
|
48
|
+
document.title = book.title + " · " + site.brand;
|
|
49
|
+
document.getElementById("topbar-slot").innerHTML = renderTopbar(site.brand, site.brandAccent, { role });
|
|
50
|
+
bindNavToggle();
|
|
51
|
+
|
|
52
|
+
const mBook = manifest.books.find((b) => b.id === bookId);
|
|
53
|
+
const md = mBook?.md?.[role];
|
|
54
|
+
const pdf = mBook?.pdf?.[role];
|
|
55
|
+
const chPath = mBook?.chapters?.[role];
|
|
56
|
+
|
|
57
|
+
document.getElementById("topline").innerHTML = `
|
|
58
|
+
<a href="/books/${encodeURIComponent(bookId)}">Book</a> /
|
|
59
|
+
<a href="/catalog?role=${encodeURIComponent(role)}">Catalog</a> /
|
|
60
|
+
<strong>${escapeHtml(book.title)}</strong>
|
|
61
|
+
<span>(${escapeHtml(role)})</span>
|
|
62
|
+
<span class="dl-row" style="margin-left:auto">
|
|
63
|
+
${md ? `<a class="btn btn-secondary btn-sm" href="${downloadHref(md)}" download>Download MD</a>` : ""}
|
|
64
|
+
${pdf ? `<a class="btn btn-secondary btn-sm" href="${downloadHref(pdf)}" download>Download PDF</a>` : ""}
|
|
65
|
+
</span>
|
|
66
|
+
`;
|
|
67
|
+
|
|
68
|
+
const frame = document.getElementById("frame");
|
|
69
|
+
frame.src = `/books/${encodeURIComponent(bookId)}/${encodeURIComponent(role)}.html`;
|
|
70
|
+
|
|
71
|
+
function buildNav(chapters) {
|
|
72
|
+
const items = chapters.map((c, i) => `
|
|
73
|
+
<li><a href="#${escapeHtml(c.slug)}" data-slug="${escapeHtml(c.slug)}">
|
|
74
|
+
<span class="num">${String(i + 1).padStart(2, "0")}</span>${escapeHtml(c.title)}
|
|
75
|
+
</a></li>`).join("");
|
|
76
|
+
document.getElementById("sidebar").innerHTML = `
|
|
77
|
+
<div class="side-block">
|
|
78
|
+
<div class="side-title">${escapeHtml(book.title)}</div>
|
|
79
|
+
<div class="side-sub">${escapeHtml(book.kicker)}</div>
|
|
80
|
+
${md ? `<a class="export-btn" href="${downloadHref(md)}" download>Download MD</a>` : ""}
|
|
81
|
+
${pdf ? `<a class="export-btn" style="background:var(--ink);margin-top:8px" href="${downloadHref(pdf)}" download>Download PDF</a>` : ""}
|
|
82
|
+
</div>
|
|
83
|
+
<ul class="chapter-nav">${items}</ul>`;
|
|
84
|
+
|
|
85
|
+
document.querySelectorAll(".chapter-nav a").forEach((a) => {
|
|
86
|
+
a.addEventListener("click", (e) => {
|
|
87
|
+
e.preventDefault();
|
|
88
|
+
const slug = a.getAttribute("data-slug");
|
|
89
|
+
location.hash = slug;
|
|
90
|
+
scrollToChapter(slug);
|
|
91
|
+
document.querySelectorAll(".chapter-nav a").forEach((x) => x.classList.remove("active"));
|
|
92
|
+
a.classList.add("active");
|
|
93
|
+
});
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
function scrollToChapter(slug) {
|
|
98
|
+
try {
|
|
99
|
+
const doc = frame.contentDocument;
|
|
100
|
+
const el = doc && doc.getElementById(slug);
|
|
101
|
+
if (el) el.scrollIntoView({ behavior: "smooth", block: "start" });
|
|
102
|
+
} catch (_) { /* ignore */ }
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
frame.addEventListener("load", () => {
|
|
106
|
+
if (hashChapter) scrollToChapter(hashChapter);
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
if (chPath) {
|
|
110
|
+
loadJson("/" + chPath.replace(/^\//, "")).then((chapters) => {
|
|
111
|
+
buildNav(chapters);
|
|
112
|
+
if (hashChapter) {
|
|
113
|
+
const active = document.querySelector(`.chapter-nav a[data-slug="${CSS.escape(hashChapter)}"]`);
|
|
114
|
+
if (active) active.classList.add("active");
|
|
115
|
+
}
|
|
116
|
+
});
|
|
117
|
+
}
|
|
118
|
+
});
|
|
119
|
+
</script>
|
|
120
|
+
</body>
|
|
121
|
+
</html>
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
{
|
|
2
|
+
"product": "Connectix",
|
|
3
|
+
"brand": "Connectix",
|
|
4
|
+
"brandAccent": "#2f6feb",
|
|
5
|
+
"siteUrl": "https://docs.x12i.dev/connectix",
|
|
6
|
+
"knowledgePackage": "@x12i/connectix-docs",
|
|
7
|
+
"footer": "Connectix — internal X12I provider connectivity service.",
|
|
8
|
+
"accent": "#2f6feb",
|
|
9
|
+
"accentAlt": "#1f6e5c",
|
|
10
|
+
"nav": [
|
|
11
|
+
{
|
|
12
|
+
"label": "Getting started",
|
|
13
|
+
"href": "/getting-started"
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"label": "Use cases",
|
|
17
|
+
"href": "/use-cases"
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"label": "Catalog",
|
|
21
|
+
"href": "/catalog"
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"label": "Agents/SDK",
|
|
25
|
+
"href": "/agents"
|
|
26
|
+
}
|
|
27
|
+
]
|
|
28
|
+
}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
|
+
<title>Use cases</title>
|
|
7
|
+
<link rel="preconnect" href="https://fonts.googleapis.com">
|
|
8
|
+
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@400;500;600;700&family=IBM+Plex+Mono:wght@400;500;600&display=swap" rel="stylesheet">
|
|
9
|
+
<link rel="stylesheet" href="/assets/site.css">
|
|
10
|
+
<link rel="stylesheet" href="/assets/extras.css">
|
|
11
|
+
</head>
|
|
12
|
+
<body class="page-use-cases" style="--accent:#2f6feb;--accent-alt:#1f6e5c" data-page="use-cases">
|
|
13
|
+
<div class="page-shell">
|
|
14
|
+
<header class="site-header">
|
|
15
|
+
<a class="brand" href="/docs">
|
|
16
|
+
<span class="brand-mark" aria-hidden="true"></span>
|
|
17
|
+
<span class="brand-name">connectix</span>
|
|
18
|
+
<span class="brand-badge">docs</span>
|
|
19
|
+
</a>
|
|
20
|
+
<button type="button" class="nav-toggle" aria-label="Menu" data-nav-toggle>Menu</button>
|
|
21
|
+
<nav class="site-nav" data-site-nav>
|
|
22
|
+
<a href="/getting-started">Getting started</a><a href="/use-cases">Use cases</a><a href="/catalog">Catalog</a><a href="/agents">Agents/SDK</a>
|
|
23
|
+
|
|
24
|
+
</nav>
|
|
25
|
+
</header>
|
|
26
|
+
<main>
|
|
27
|
+
<section class="hero">
|
|
28
|
+
<div class="hero-kicker">Task-first</div>
|
|
29
|
+
<h1>Connectix use cases</h1>
|
|
30
|
+
<p class="hero-lead">Pick the job you have — orient, expose tools, run the simulator, or understand catalog provenance.</p>
|
|
31
|
+
|
|
32
|
+
</section>
|
|
33
|
+
<section class="install-callout" aria-label="Install knowledge package">
|
|
34
|
+
<div class="install-callout-inner">
|
|
35
|
+
<div class="install-kicker">npm</div>
|
|
36
|
+
<h2 class="install-title">Install for agents & tooling</h2>
|
|
37
|
+
<p class="install-lead">Knowledge SDK — install as a <strong>devDependency</strong> only (not a production runtime).</p>
|
|
38
|
+
<pre class="install-cmd install-cmd-primary"><code>npm i -D @x12i/connectix-docs</code></pre>
|
|
39
|
+
|
|
40
|
+
<p class="install-more"><a href="/agents">Agents / SDK details →</a> · <a href="/agent-manifest.json">agent-manifest.json</a></p>
|
|
41
|
+
</div>
|
|
42
|
+
</section>
|
|
43
|
+
<section class="section" data-hydrate="use-cases"><div id="use-cases-root"></div></section>
|
|
44
|
+
<section class="section prose"><p>Each use case packs the relevant book chapters into one markdown document for humans and agents.</p>
|
|
45
|
+
</section>
|
|
46
|
+
</main>
|
|
47
|
+
<footer class="site-footer">
|
|
48
|
+
<div class="footer-id">Connectix — internal X12I provider connectivity service.</div>
|
|
49
|
+
<nav class="footer-nav">
|
|
50
|
+
<a href="/docs">Docs home</a><a href="/getting-started">Getting started</a><a href="/use-cases">Use cases</a><a href="/catalog">Catalog</a><a href="/agents">Agents/SDK</a>
|
|
51
|
+
</nav>
|
|
52
|
+
</footer>
|
|
53
|
+
</div>
|
|
54
|
+
<script src="/app.js"></script>
|
|
55
|
+
<script>
|
|
56
|
+
document.querySelectorAll("[data-nav-toggle]").forEach((btn) => {
|
|
57
|
+
btn.addEventListener("click", () => {
|
|
58
|
+
document.querySelector("[data-site-nav]")?.classList.toggle("open");
|
|
59
|
+
});
|
|
60
|
+
});
|
|
61
|
+
</script>
|
|
62
|
+
<script>
|
|
63
|
+
if (typeof hydratePage === "function") hydratePage(document.body.dataset.page);
|
|
64
|
+
</script>
|
|
65
|
+
</body>
|
|
66
|
+
</html>
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
{
|
|
2
|
+
"useCases": [
|
|
3
|
+
{
|
|
4
|
+
"id": "orient-connectix",
|
|
5
|
+
"title": "Orient on Connectix",
|
|
6
|
+
"goal": "Understand what Connectix is, the four curated operations, and the caller contract before writing any integration code.",
|
|
7
|
+
"audiences": [
|
|
8
|
+
"developers"
|
|
9
|
+
],
|
|
10
|
+
"tags": [
|
|
11
|
+
"orientation",
|
|
12
|
+
"getting-started"
|
|
13
|
+
],
|
|
14
|
+
"path": [
|
|
15
|
+
{
|
|
16
|
+
"bookId": "00-orient-connectix",
|
|
17
|
+
"audience": "developers",
|
|
18
|
+
"chapters": [
|
|
19
|
+
"1-what-connectix-is",
|
|
20
|
+
"2-call-styles-and-auth",
|
|
21
|
+
"3-ownership-boundaries"
|
|
22
|
+
]
|
|
23
|
+
}
|
|
24
|
+
],
|
|
25
|
+
"alsoSee": [
|
|
26
|
+
"call-connect-tools"
|
|
27
|
+
]
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"id": "call-connect-tools",
|
|
31
|
+
"title": "Expose Connectix as AI tools",
|
|
32
|
+
"goal": "Register the four connect tools from @x12i/connectix-tools in an LLM tool registry and run them against a live service or the simulator.",
|
|
33
|
+
"audiences": [
|
|
34
|
+
"developers"
|
|
35
|
+
],
|
|
36
|
+
"tags": [
|
|
37
|
+
"ai-tools",
|
|
38
|
+
"agents"
|
|
39
|
+
],
|
|
40
|
+
"path": [
|
|
41
|
+
{
|
|
42
|
+
"bookId": "01-tools-and-simulator",
|
|
43
|
+
"audience": "developers",
|
|
44
|
+
"chapters": [
|
|
45
|
+
"1-the-four-connect-tools",
|
|
46
|
+
"3-stub-and-live-execution"
|
|
47
|
+
]
|
|
48
|
+
}
|
|
49
|
+
],
|
|
50
|
+
"alsoSee": [
|
|
51
|
+
"run-package-simulator"
|
|
52
|
+
]
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"id": "run-package-simulator",
|
|
56
|
+
"title": "Develop against the package simulator",
|
|
57
|
+
"goal": "Use @x12i/connectix-simulator for deterministic local development and tests without the service, Credorix, or providers.",
|
|
58
|
+
"audiences": [
|
|
59
|
+
"developers"
|
|
60
|
+
],
|
|
61
|
+
"tags": [
|
|
62
|
+
"simulator",
|
|
63
|
+
"testing"
|
|
64
|
+
],
|
|
65
|
+
"path": [
|
|
66
|
+
{
|
|
67
|
+
"bookId": "01-tools-and-simulator",
|
|
68
|
+
"audience": "developers",
|
|
69
|
+
"chapters": [
|
|
70
|
+
"2-run-the-package-simulator"
|
|
71
|
+
]
|
|
72
|
+
}
|
|
73
|
+
],
|
|
74
|
+
"alsoSee": [
|
|
75
|
+
"call-connect-tools"
|
|
76
|
+
]
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"id": "catalog-extension-overview",
|
|
80
|
+
"title": "Understand catalog extension provenance",
|
|
81
|
+
"goal": "Know how OpenConnector, n8n-node, and Nango-derived implementations reach the catalog while callers stay source-agnostic.",
|
|
82
|
+
"audiences": [
|
|
83
|
+
"developers"
|
|
84
|
+
],
|
|
85
|
+
"tags": [
|
|
86
|
+
"catalog",
|
|
87
|
+
"provenance"
|
|
88
|
+
],
|
|
89
|
+
"path": [
|
|
90
|
+
{
|
|
91
|
+
"bookId": "01-tools-and-simulator",
|
|
92
|
+
"audience": "developers",
|
|
93
|
+
"chapters": [
|
|
94
|
+
"4-catalog-extension-overview"
|
|
95
|
+
]
|
|
96
|
+
}
|
|
97
|
+
],
|
|
98
|
+
"alsoSee": [
|
|
99
|
+
"orient-connectix"
|
|
100
|
+
]
|
|
101
|
+
}
|
|
102
|
+
]
|
|
103
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@x12i/connectix-docs",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Connectix docs knowledge SDK + deployable dist/web static site. Install the package as a devDependency only; deploy dist/web for humans.",
|
|
5
|
+
"license": "UNLICENSED",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"main": "./dist/index.js",
|
|
8
|
+
"types": "./dist/index.d.ts",
|
|
9
|
+
"bin": {
|
|
10
|
+
"connectix-docs": "bin/connectix-docs.js"
|
|
11
|
+
},
|
|
12
|
+
"exports": {
|
|
13
|
+
".": {
|
|
14
|
+
"types": "./dist/index.d.ts",
|
|
15
|
+
"import": "./dist/index.js"
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"files": [
|
|
19
|
+
"dist",
|
|
20
|
+
"!dist/**/*.test.*",
|
|
21
|
+
"bin",
|
|
22
|
+
"README.md"
|
|
23
|
+
],
|
|
24
|
+
"scripts": {
|
|
25
|
+
"docs:web": "node scripts/build-web.mjs",
|
|
26
|
+
"docs:knowledge": "node scripts/build-knowledge.mjs",
|
|
27
|
+
"bundle": "node scripts/build-web.mjs && node scripts/build-knowledge.mjs",
|
|
28
|
+
"docs": "node scripts/docs.mjs",
|
|
29
|
+
"docs:serve": "node scripts/docs.mjs --no-open",
|
|
30
|
+
"prebuild": "node scripts/build-web.mjs && node scripts/build-knowledge.mjs",
|
|
31
|
+
"build": "tsc -b",
|
|
32
|
+
"typecheck": "tsc -b --pretty false",
|
|
33
|
+
"prepublishOnly": "npm run bundle && npm run build"
|
|
34
|
+
},
|
|
35
|
+
"engines": {
|
|
36
|
+
"node": ">=22.0.0"
|
|
37
|
+
},
|
|
38
|
+
"dependencies": {
|
|
39
|
+
"@x12i/docify-core": "^1.0.2",
|
|
40
|
+
"@x12i/docify-sdk": "^1.0.1"
|
|
41
|
+
},
|
|
42
|
+
"devDependencies": {
|
|
43
|
+
"@x12i/docify-export": "^1.0.1",
|
|
44
|
+
"@x12i/docify-render": "^1.0.2",
|
|
45
|
+
"@x12i/docify-theme": "^1.0.4",
|
|
46
|
+
"@x12i/docify-web": "^1.0.4"
|
|
47
|
+
},
|
|
48
|
+
"publishConfig": {
|
|
49
|
+
"access": "public",
|
|
50
|
+
"registry": "https://registry.npmjs.org/"
|
|
51
|
+
},
|
|
52
|
+
"repository": {
|
|
53
|
+
"type": "git",
|
|
54
|
+
"url": "git+ssh://git@github.com/x12i/connectix.git",
|
|
55
|
+
"directory": "packages/connectix-docs"
|
|
56
|
+
},
|
|
57
|
+
"keywords": [
|
|
58
|
+
"x12i",
|
|
59
|
+
"connectix",
|
|
60
|
+
"docs",
|
|
61
|
+
"knowledge",
|
|
62
|
+
"devDependency"
|
|
63
|
+
]
|
|
64
|
+
}
|