@claritylabs/cl-sdk-docs

Documentation content for @claritylabs/cl-sdk. This package contains the raw MDX files and navigation metadata — no rendering code.

This package is versioned with the CL SDK major release line. Use @claritylabs/cl-sdk-docs@^1.0.0 with @claritylabs/cl-sdk@^1.0.0.

Usage

Install and read at build time:

npm install @claritylabs/cl-sdk-docs

import fs from "fs";
import path from "path";

const docsRoot = path.join(
  process.cwd(),
  "node_modules/@claritylabs/cl-sdk-docs",
);
const nav = JSON.parse(fs.readFileSync(path.join(docsRoot, "meta.json"), "utf-8"));

Contents

• meta.json — navigation structure (sections and pages)
• **/*.mdx — documentation pages with YAML frontmatter

v1 documentation includes source grounding, extraction performance controls, PCE workflows, case workflow primitives, migration notes, API references, storage guidance, and the release changelog.

Frontmatter

title: string       # Page title
description: string # One-line summary
tocSections:        # Optional — table of contents entries
  - { id: string, label: string, level?: 2 | 3 }

MDX components

The MDX files reference these components (provided by the consuming app, not this package):

• Callout — info/warning/error boxes
• Card / Cards — navigation cards
• Tabs / Tab — tabbed content
• Section — scroll-anchor wrapper

License

MIT