Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions docs/website/content/docs/about-qvac/flagship-apps.mdx
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
1 change: 1 addition & 0 deletions docs/website/content/docs/about-qvac/how-it-works.mdx
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
1 change: 1 addition & 0 deletions docs/website/content/docs/about-qvac/public-launch.mdx
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/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/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
1 change: 1 addition & 0 deletions docs/website/content/docs/addons/diffusion-cpp/index.mdx
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/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
1 change: 1 addition & 0 deletions docs/website/content/docs/addons/llm-llamacpp/index.mdx
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
1 change: 1 addition & 0 deletions docs/website/content/docs/addons/ocr-onnx/index.mdx
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
1 change: 1 addition & 0 deletions docs/website/content/docs/addons/tts-onnx/index.mdx
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/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/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/sdk/api/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: API Summary — v0.9.1 (latest)
description: One-page reference of all public functions and objects exported by @qvac/sdk
schemaType: APIReference
---

> Auto-generated from `.d.ts` declarations and TSDoc comments.
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/sdk/api/v0.7.0.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: API Summary — v0.7.0
description: One-page reference of all public functions and objects exported by @qvac/sdk
schemaType: APIReference
---

> Auto-generated from `.d.ts` declarations and TSDoc comments.
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/sdk/api/v0.8.0.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: API Summary — v0.8.0
description: One-page reference of all public functions and objects exported by @qvac/sdk
schemaType: APIReference
---

> Auto-generated from `.d.ts` declarations and TSDoc comments.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Completion
description: LLM inference for text generation and chat — i.e., use a large language model to generate text output based on input prompts and context.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Fine-tuning
description: Adapting LLMs to domain-specific tasks via LoRA — i.e., train small adapter weights on custom datasets to specialize model behavior.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Image generation
description: Text-to-image and image-to-image generation using Stable Diffusion.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Multimodal
description: LLM inference over text, images, and other media within a single conversation context.
schemaType: HowTo
---

## Overview
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/sdk/examples/ai-tasks/ocr.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: OCR
description: Optical character recognition (OCR) for extracting text from images.
schemaType: HowTo
---

## Overview
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/sdk/examples/ai-tasks/rag.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: RAG
description: Out-of-the-box retrieval-augmented generation workflow.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Text embeddings
description: Vector embedding generation for semantic search, clustering, and retrieval.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Text-to-Speech
description: Speech synthesis for text-to-speech (TTS) — i.e., generate audio using custom voices from written input.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Transcription
description: Automatic speech recognition (ASR) for speech-to-text — i.e., generate text transcriptions from audio input.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Translation
description: Text-to-text neural machine translation (NMT) — i.e., translate text between different languages.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Blind relays
description: Establish peer connections through NAT/firewalls by routing traffic via relay nodes.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Delegated inference
description: Perform peer-to-peer inference delegation out-of-the-box via Holepunch stack, enabling resource sharing.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Download lifecycle
description: Pause and resume model downloads.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Logging
description: Visibility into what's happening during loading, inference, and other operations.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Plugin system
description: Enable and disable built-in AI capabilities, and add new ones via custom plugins.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Profiler
description: Measure and export timing metrics across model loading, inference, and P2P delegation.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Runtime lifecycle
description: Suspend and resume the SDK runtime (e.g., when the host app moves to background) and query lifecycle state.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Sharded models
description: Download a model that is sharded into multiple parts.
schemaType: HowTo
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Write a custom plugin
description: Guidelines to ship your custom plugin as a single npm package.
schemaType: HowTo
---

import { File, Folder, Files } from "fumadocs-ui/components/files";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Configuration
description: Use qvac.config.* to configure QVAC's overall behavior.
schemaType: HowTo
---

## Overview
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/sdk/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: SDK
description: Use the JS/TS SDK to build local and P2P AI applications and systems.
ogImage: /og-sdk-main.png
schemaType: TechArticle
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Installation
description: Supported environments and how to install the SDK for each one.
ogImage: /og-sdk-installation.png
schemaType: HowTo
---

## Supported environments
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Quickstart
description: Run your first example using the JS/TS SDK. At the end, you'll find instructions to run any example in this documentation.
ogImage: /og-sdk-quickstart.png
schemaType: HowTo
---

## Requirements
Expand Down
1 change: 1 addition & 0 deletions docs/website/content/docs/sdk/release-notes/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: SDK Release Notes — v0.9.1
description: QVAC SDK release notes
schemaType: TechArticle
---

📦 **NPM:** https://www.npmjs.com/package/@qvac/sdk/v/0.9.1
Expand Down
Loading
Loading