Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions .cursor/rules/website/main.mdc
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
description: documentation website - source code and content
globs: docs/website/**
alwaysApply: false
---

# Documentation Website

## Language

All generated text MUST be written in English.

## Project Context

QVAC is an OSS ecosystem for developers building local AI applications and systems.

`docs/website` is the developer portal for QVAC project.

The goal of this context (chat) is to improve this website. This includes: the website source code AND all the resources we provide for our developer-users to be capable of using QVAC — references, tutorials, learning materials, code examples, templates, starter kits, etc.

## Repository Layout

`docs/website/` contains website source code and WITHIN it, `docs/website/content/` contains all content (resources) in MDX files.

## Tech Stack

- **Framework:** Next.js + Fumadocs
- **Output:** 100% static site. At build time, all HTML pages are generated into `docs/website/out/` and then served from a CDN. There is no server-side runtime.

## Scope of Work

The goal of this context is one of the following or both:

1. Improve website source code: changes to components, configuration, styling, or build pipeline under `docs/website/`
2. Generate new content: create or update pages under `docs/website/content/`

## Environments

- Production: https://docs.qvac.tether.io
- Staging: https://docs.qvac.tether.su
5 changes: 1 addition & 4 deletions docs/website/.env.example
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# Production docs (Sevalla): set at build time on the app that serves https://docs.qvac.tether.io
# so static HTML declares index,follow. Omit on preview/staging/PR builds.
# DOCS_ALLOW_INDEXING=1

# Force noindex in static HTML even when DOCS_ALLOW_INDEXING is set (emergency / wrong environment).
# DOCS_FORCE_NOINDEX=1
# DOCS_ALLOW_INDEXING=true

# Inkeep API Key for search and chat functionality
NEXT_PUBLIC_INKEEP_API_KEY=your_inkeep_api_key_here
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Flagship applications
description: Desktop and mobile apps to empower users and showcase QVAC capabilities.
ogImage: /og-flagship-apps.png
schemaType: TechArticle
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: How it works
description: Understand what happens under the hood when you use QVAC SDK in your application.
schemaType: TechArticle
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Public launch
description: Tether's public launch of QVAC at Plan B Forum Lugano (October 2025) — keynotes from Paolo Ardoino, Subash, and Marco Chiappetta.
schemaType: TechArticle
---

Tether publicly launched QVAC in October 2025 at the Plan B Forum in Lugano. During the forum, Tether CEO Paolo Ardoino presented QVAC's future vision in his keynote, _Fiat Lux_:
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/about-qvac/vision.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Our vision
description: "Tether's vision for QVAC — the Infinite Stable Intelligence Platform — local-first AI at the edge, the foundational layer for the decentralized mind."
ogImage: /og-vision.png
schemaType: TechArticle
---

## The world is waking up
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/about-qvac/welcome.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Welcome
description: Learn what QVAC is, why Tether built it, and what makes it different.
ogImage: /og-welcome.png
schemaType: TechArticle
---

## What is QVAC?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "@qvac/diffusion-cpp"
titleStyle: code
description: Text-to-image generation from text prompts.
schemaType: APIReference
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "@qvac/embed-llamacpp"
titleStyle: code
description: Vector embedding generation for semantic search, clustering, and retrieval that seamlessly supports retrieval-augmented generation workflow.
schemaType: APIReference
---

## Overview
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/addons/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Addons
description: Reference for the QVAC components that provide AI capabilities.
ogImage: /og-addons.png
schemaType: APIReference
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "@qvac/llm-llamacpp"
titleStyle: code
description: LLM inference for text generation and chat with support to images, and other media within a single conversation context.
schemaType: APIReference
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "@qvac/ocr-onnx"
titleStyle: code
description: Optical character recognition (OCR) for extracting text from images.
schemaType: APIReference
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "@qvac/transcription-parakeet"
titleStyle: code
description: Automatic speech recognition (ASR) for speech-to-text with speaker diarization.
schemaType: APIReference
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "@qvac/transcription-whispercpp"
titleStyle: code
description: Automatic speech recognition (ASR) for speech-to-text.
schemaType: APIReference
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "@qvac/translation-nmtcpp"
titleStyle: code
description: Text-to-text neural machine translation (NMT).
schemaType: APIReference
---

> **Migration Note (v1.0.0+):** Opus/Marian model support has been removed. Only IndicTrans2 and Bergamot backends are supported. If you were using Opus models, migrate to Bergamot for European language pairs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "@qvac/tts-onnx"
titleStyle: code
description: Speech synthesis for text-to-speech (TTS).
schemaType: APIReference
---

## Overview
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: CLI
description: QVAC CLI provides tools and an HTTP server that exposes an OpenAI-compatible API.
ogImage: /og-cli.png
schemaType: TechArticle
---

## Overview
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/http-server.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: HTTP server
description: Run a local HTTP server that exposes an OpenAI-compatible API.
schemaType: TechArticle
---

## Overview
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/sdk/api/cancel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "cancel( )"
titleStyle: code
description: Cancels an ongoing operation.
schemaType: APIReference
---

```ts
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/sdk/api/close.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "close( )"
titleStyle: code
description: Closes the SDK client connection and releases all associated resources.
schemaType: APIReference
---

```ts
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/sdk/api/completion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "completion( )"
titleStyle: code
description: Generates completion from a language model based on conversation history.
schemaType: APIReference
---

```ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "defineDuplexHandler( )"
titleStyle: code
description: Helper function to define a duplex (bidirectional streaming) handler with full type inference.
schemaType: APIReference
---

```ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "defineHandler( )"
titleStyle: code
description: Helper function to define a handler with full type inference.
schemaType: APIReference
---

```ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "definePlugin( )"
titleStyle: code
description: Helper function to define a plugin with full type inference.
schemaType: APIReference
---

```ts
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/sdk/api/deleteCache.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "deleteCache( )"
titleStyle: code
description: Deletes KV cache files.
schemaType: APIReference
---

```ts
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/sdk/api/diffusion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "diffusion( )"
titleStyle: code
description: Generates images using a loaded diffusion model.
schemaType: APIReference
---

```ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "downloadAsset( )"
titleStyle: code
description: Downloads an asset (model file) without loading it into memory.
schemaType: APIReference
---

```ts
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/sdk/api/embed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "embed( )"
titleStyle: code
description: Generates embeddings for a single text using a specified model.
schemaType: APIReference
---

```ts
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/sdk/api/errors.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Errors
description: SDK error codes reference
schemaType: APIReference
---

## Example
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/sdk/api/finetune.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "finetune( )"
titleStyle: code
description: Starts, resumes, inspects, pauses, or cancels a finetuning job for a loaded model.
schemaType: APIReference
---

```ts
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/sdk/api/getLogger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "getLogger( )"
titleStyle: code
description: Creates or retrieves a cached logger instance for the given namespace.
schemaType: APIReference
---

```ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "getModelByName( )"
titleStyle: code
description: Retrieves a model constant from the built-in registry by its human-readable name.
schemaType: APIReference
---

```ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "getModelByPath( )"
titleStyle: code
description: Looks up a model in the built-in catalog by its registry path.
schemaType: APIReference
---

```ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "getModelBySrc( )"
titleStyle: code
description: Retrieves a model constant from the built-in registry by its model ID and blob core key.
schemaType: APIReference
---

```ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "getModelInfo( )"
titleStyle: code
description: Retrieves detailed information about a model, including cache status and loaded instances.
schemaType: APIReference
---

```ts
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/sdk/api/heartbeat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "heartbeat( )"
titleStyle: code
description: Checks if a delegated provider or the local SDK worker is responsive.
schemaType: APIReference
---

```ts
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/sdk/api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "@qvac/sdk"
titleStyle: code
description: API reference — v0.9.0
schemaType: APIReference
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "invokePlugin( )"
titleStyle: code
description: Invoke a non-streaming plugin handler.
schemaType: APIReference
---

```ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "invokePluginStream( )"
titleStyle: code
description: Invoke a streaming plugin handler.
schemaType: APIReference
---

```ts
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/sdk/api/loadModel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "loadModel( )"
titleStyle: code
description: Loads a machine learning model from a local path, remote URL, or Hyperdrive key.
schemaType: APIReference
---

```ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "loggingStream( )"
titleStyle: code
description: Opens a logging stream to receive real-time logs.
schemaType: APIReference
---

```ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "modelRegistryGetModel( )"
titleStyle: code
description: Retrieves a single model entry from the QVAC model registry by path and source.
schemaType: APIReference
---

```ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "modelRegistryList( )"
titleStyle: code
description: Returns all available models from the QVAC distributed model registry.
schemaType: APIReference
---

```ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "modelRegistrySearch( )"
titleStyle: code
description: Searches the QVAC model registry with optional filters.
schemaType: APIReference
---

```ts
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/(latest)/sdk/api/ocr.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "ocr( )"
titleStyle: code
description: Performs Optical Character Recognition (OCR) on an image to extract text.
schemaType: APIReference
---

```ts
Expand Down
Loading
Loading