@doxbrix/doxloop 0.1.0

package/skills/doxloop-doxbrix/references/components.md

@@ -0,0 +1,137 @@
+# Doxbrix component syntax
+
+Use standard Markdown for headings, prose, links, lists, tables, blockquotes,
+images, and fenced code. Use these MDX components when they improve the reader
+experience.
+
+## Procedures and alternatives
+
+```mdx
+<Steps>
+<Step title="Install the CLI">
+Run the installer and verify the executable.
+</Step>
+<Step title="Authenticate">Run `tool login`.</Step>
+</Steps>
+```
+
+````mdx
+<CodeGroup>
+```bash npm
+npm install package
+```
+```bash pnpm
+pnpm add package
+```
+</CodeGroup>
+````
+
+```mdx
+<Tabs>
+<Tab label="macOS">Install with Homebrew.</Tab>
+<Tab label="Windows">Download the installer.</Tab>
+</Tabs>
+```
+
+`<Tab title="…">` is also accepted for compatibility. Do not use Docusaurus
+`<TabItem>` inside Doxbrix tabs.
+
+## Callouts
+
+```mdx
+<Info>Neutral supporting information.</Info>
+<Note>Context the reader should remember.</Note>
+<Tip>A useful best practice.</Tip>
+<Check>A successful result or confirmation.</Check>
+<Warning>A risk the reader can avoid.</Warning>
+<Danger>A destructive or critical consequence.</Danger>
+```
+
+## Navigation and disclosure
+
+```mdx
+<CardGroup cols="2">
+<Card title="Quickstart" icon="🚀" href="/quickstart">Get started.</Card>
+<Card title="Configuration" icon="⚙️" href="/configuration">Choose settings.</Card>
+</CardGroup>
+```
+
+```mdx
+<Accordion>
+<AccordionItem title="Can I change this later?">Yes.</AccordionItem>
+</Accordion>
+
+<Expandable title="Show advanced options">Advanced details.</Expandable>
+```
+
+## Layout and visual blocks
+
+```mdx
+<Columns cols="2">
+<Column>Left content.</Column>
+<Column>Right content.</Column>
+</Columns>
+
+<Terminal>$ npm run build</Terminal>
+<Badge color="green">New</Badge>
+<Icon emoji="⚡" size="lg">Fast</Icon>
+```
+
+## Media, updates, diagrams, and API reference
+
+```mdx
+<Image src="/images/flow.png" alt="Request flow" caption="How requests move" />
+<Frame caption="The highlighted control opens the invitation form.">
+
+![Team settings with the Invite member control highlighted](/assets/guides/invite-team-member/01-team-settings.png)
+
+</Frame>
+<Video url="https://example.com/video" />
+<Embed src="https://example.com/demo" />
+<Frame url="https://example.com" title="Live example" />
+<File name="report.pdf" url="/files/report.pdf" fileType="pdf" />
+
+<Update type="new" version="2.1.0" date="June 8, 2026">
+Shipped the new workflow.
+</Update>
+
+<Mermaid>
+graph TD; A[Start] --> B[Complete];
+</Mermaid>
+
+<Math>e = mc^2</Math>
+```
+
+```mdx
+<ApiEndpoint method="POST" path="/users" baseUrl="https://api.example.com" summary="Create a user">
+<Param name="name" in="body" type="string" required>Display name</Param>
+<Response status={200} contentType="application/json" description="Created">
+{ "id": "u_123" }
+</Response>
+</ApiEndpoint>
+```
+
+For API reference pages, read [api-endpoints.md](api-endpoints.md). Its complete
+page contract and example are required; this compact component catalog example
+is not a sufficient endpoint page by itself.
+
+Also supported: standalone `<Card>`, `<AccordionItem>`, `<AccordionGroup>`, and
+`<Excalidraw>`.
+
+For standalone API blocks:
+
+```mdx
+<ParameterTable title="Query parameters">
+<Param name="limit" in="query" type="number">Maximum results.</Param>
+</ParameterTable>
+
+<ResponseExample>
+<Response status="200" contentType="application/json" description="Success">
+{ "ok": true }
+</Response>
+</ResponseExample>
+```
+
+Never invent a component outside this catalog. After adding a rich component,
+inspect that component in `doxloop preview`; balanced tags alone do not prove
+that its attributes or content are correct.

package/skills/doxloop-doxbrix/references/manifest.md

@@ -0,0 +1,117 @@
+# Doxbrix project format
+
+The canonical manifest is `docs/docs.json` for a Doxloop project whose
+`contentDir` is `docs`.
+
+```json
+{
+  "version": 1,
+  "name": "Example",
+  "description": "Learn how to use Example.",
+  "spaces": [
+    {
+      "name": "Documentation",
+      "slug": "docs",
+      "icon": "book",
+      "nav": [
+        {
+          "type": "group",
+          "label": "Get started",
+          "icon": "rocket",
+          "items": [
+            {
+              "type": "page",
+              "file": "index",
+              "title": "Overview",
+              "icon": "compass"
+            },
+            {
+              "type": "page",
+              "file": "quickstart",
+              "icon": "bolt"
+            }
+          ]
+        },
+        {
+          "type": "link",
+          "title": "Service status",
+          "href": "https://status.example.com",
+          "icon": "globe"
+        },
+        {
+          "type": "api",
+          "title": "HTTP API",
+          "spec": "openapi.yaml",
+          "icon": "plug"
+        }
+      ]
+    }
+  ],
+  "theme": {
+    "primaryColor": "#6366f1",
+    "lightColor": "#4f46e5",
+    "darkColor": "#818cf8",
+    "mode": "system",
+    "font": "Inter",
+    "headingFont": "Inter",
+    "codeFont": "JetBrains Mono",
+    "logoLight": "/assets/logo-light.svg",
+    "logoDark": "/assets/logo-dark.svg",
+    "logoHref": "https://example.com",
+    "favicon": "/assets/favicon.svg",
+    "backgroundColorLight": "#ffffff",
+    "backgroundColorDark": "#12131a",
+    "fontSources": [
+      {
+        "family": "Inter",
+        "source": "/fonts/inter-regular.woff2",
+        "format": "woff2",
+        "weight": 400
+      }
+    ]
+  }
+}
+```
+
+Page `file` values are relative to the content directory without `.md` or
+`.mdx`. A group can contain pages and nested groups.
+
+Supported navigation nodes:
+
+- `page`: `file`, with optional `title`, `icon`, and `hidden`;
+- `group`: `label` and nested `items`, with optional `icon` and `hidden`;
+- `label`: non-clickable section text;
+- `divider`: visual separation;
+- `link`: external or internal `title` and `href`, with optional `icon`;
+- `api`: API reference `title` and specification path, with optional `icon`.
+
+Every reader-facing page should appear exactly once in navigation.
+
+## Navigation icons
+
+Give each space and primary group, page, link, and API node a semantic `icon`.
+Prefer stable lowercase kebab-case Doxbrix names such as `book`, `rocket`,
+`compass`, `bolt`, `globe`, and `plug`. Reuse one icon for one concept, preserve
+an established project vocabulary, and avoid decorative or arbitrary choices.
+Keep the visible `name`, `label`, or `title`; an icon never replaces text.
+For a page with an explicit navigation icon, put the same semantic icon in the
+page frontmatter so local preview and deployed page metadata stay aligned.
+Labels and dividers do not take icons.
+
+## Theme values
+
+Use six-digit hexadecimal colors. `mode` is `light`, `dark`, or `system`.
+
+- `primaryColor`: default accent;
+- `lightColor` and `darkColor`: accessible accent variants for each mode;
+- `font`, `headingFont`, and `codeFont`: font-family names;
+- `logoLight`, `logoDark`, and `favicon`: public root-relative or HTTPS assets;
+- `logoHref`: an HTTPS or root-relative destination for the logo;
+- `backgroundColorLight`, `backgroundColorDark`, and `backgroundImage`: reader
+  backgrounds;
+- `fontSources`: copied local font files with `family`, `source`, `format`,
+  `weight`, and optional `style`.
+
+Root-relative assets resolve from the documentation content directory. Copy
+them into that directory; never point the manifest at the configured product
+source.