From 35ab0d4896206867e8885c1797f5a1659c04b366 Mon Sep 17 00:00:00 2001 From: Saba Gogichaishvili Date: Thu, 12 Feb 2026 08:56:16 +0100 Subject: [PATCH] rename qvac-docs to docs --- .cursor/rules/sdk/commit-and-pr-format.mdc | 39 ++++++++--- .cursor/rules/sdk/sdk-pod-packages.mdc | 5 +- .../rules/sdk/skill-authoring-guidelines.mdc | 62 ++++++++++++++---- .cursor/skills/sdk-changelog/SKILL.md | 16 +++-- .github/sdk-pod-checks.json | 4 +- .github/workflows/pr-checks-sdk-pod.yml | 2 +- .github/workflows/pr-validation-sdk-pod.yml | 2 +- .../repository-dispatch-qvac-sdk.yml | 2 +- packages/{qvac-docs => docs}/.env.example | 0 packages/{qvac-docs => docs}/.gitignore | 0 packages/{qvac-docs => docs}/LICENSE | 0 packages/{qvac-docs => docs}/README.md | 0 packages/{qvac-docs => docs}/cli.json | 0 .../docs/addons/embed-llamacpp/index.mdx | 0 .../content/docs/addons/index.mdx | 0 .../docs/addons/llm-llamacpp/index.mdx | 0 .../content/docs/addons/ocr-onnx/index.mdx | 0 .../addons/transcription-whispercpp/index.mdx | 0 .../docs/addons/translation-nmtcpp/index.mdx | 0 .../content/docs/addons/tts-onnx/index.mdx | 0 .../content/docs/discover.mdx | 0 .../content/docs/flagship-apps.mdx | 0 .../content/docs/index.mdx | 0 .../content/docs/sdk/api/latest/cancel.mdx | 0 .../content/docs/sdk/api/latest/close.mdx | 0 .../docs/sdk/api/latest/completion.mdx | 0 .../docs/sdk/api/latest/deleteCache.mdx | 0 .../docs/sdk/api/latest/downloadAsset.mdx | 0 .../content/docs/sdk/api/latest/embed.mdx | 0 .../content/docs/sdk/api/latest/getLogger.mdx | 0 .../docs/sdk/api/latest/getModelByName.mdx | 0 .../docs/sdk/api/latest/getModelBySrc.mdx | 0 .../docs/sdk/api/latest/getModelInfo.mdx | 0 .../content/docs/sdk/api/latest/index.mdx | 0 .../content/docs/sdk/api/latest/loadModel.mdx | 0 .../docs/sdk/api/latest/loggingStream.mdx | 0 .../content/docs/sdk/api/latest/ocr.mdx | 0 .../content/docs/sdk/api/latest/ping.mdx | 0 .../sdk/api/latest/ragDeleteEmbeddings.mdx | 0 .../docs/sdk/api/latest/ragSaveEmbeddings.mdx | 0 .../content/docs/sdk/api/latest/ragSearch.mdx | 0 .../docs/sdk/api/latest/startQVACProvider.mdx | 0 .../docs/sdk/api/latest/stopQVACProvider.mdx | 0 .../docs/sdk/api/latest/textToSpeech.mdx | 0 .../docs/sdk/api/latest/transcribe.mdx | 0 .../docs/sdk/api/latest/transcribeStream.mdx | 0 .../content/docs/sdk/api/latest/translate.mdx | 0 .../docs/sdk/api/latest/unloadModel.mdx | 0 .../content/docs/sdk/blind-relays.mdx | 0 .../content/docs/sdk/completion.mdx | 0 .../content/docs/sdk/configuration.mdx | 0 .../content/docs/sdk/delegated-inference.mdx | 0 .../content/docs/sdk/download-lifecycle.mdx | 0 .../content/docs/sdk/how-it-works.mdx | 0 .../content/docs/sdk/index.mdx | 0 .../content/docs/sdk/install.mdx | 0 .../content/docs/sdk/logging.mdx | 0 .../content/docs/sdk/multimodal.mdx | 0 .../content/docs/sdk/ocr.mdx | 0 .../content/docs/sdk/quickstart.mdx | 0 .../content/docs/sdk/rag.mdx | 0 .../content/docs/sdk/release-notes/v0-5.mdx | 0 .../content/docs/sdk/sharded-models.mdx | 0 .../content/docs/sdk/text-embeddings.mdx | 0 .../content/docs/sdk/text-to-speech.mdx | 0 .../content/docs/sdk/transcription.mdx | 0 .../content/docs/sdk/translation.mdx | 0 .../content/docs/sdk/tutorials/electron.mdx | 0 .../content/docs/sdk/tutorials/expo.mdx | 0 .../content/docs/sdk/tutorials/pear.mdx | 0 .../content/docs/vision.mdx | 0 packages/{qvac-docs => docs}/next.config.mjs | 0 .../{qvac-docs => docs}/package-lock.json | 4 +- packages/{qvac-docs => docs}/package.json | 2 +- .../{qvac-docs => docs}/postcss.config.mjs | 0 .../public/featurebase.svg | 0 .../{qvac-docs => docs}/public/health.svg | 0 packages/{qvac-docs => docs}/public/keet.svg | 0 packages/{qvac-docs => docs}/public/llms.txt | 0 packages/{qvac-docs => docs}/public/pear.svg | 0 .../public/qvac-favicon.ico | Bin .../public/qvac-favicon.svg | 0 .../{qvac-docs => docs}/public/qvac-logo.svg | 0 .../screencasts/electron-tutorial-demo.webm | Bin .../screencasts/pear-tutorial-demo.webm | Bin .../public/screenshots/electron-window.png | Bin .../screenshots/pear-task-completed.png | Bin .../public/screenshots/pear-window.png | Bin .../public/screenshots/tailwindcss.png | Bin .../public/screenshots/task-completed.png | Bin .../public/screenshots/ui-chat.png | Bin .../public/screenshots/vite-renderer.png | Bin .../{qvac-docs => docs}/public/workbench.svg | 0 .../scripts/check-links.js | 0 packages/{qvac-docs => docs}/source.config.ts | 0 .../src/app/(docs)/[[...slug]]/page.tsx | 0 .../src/app/(docs)/layout.tsx | 0 .../src/app/api/search/route.ts | 0 .../{qvac-docs => docs}/src/app/global.css | 0 .../{qvac-docs => docs}/src/app/layout.tsx | 0 .../src/app/llms-full.txt/route.ts | 0 .../{qvac-docs => docs}/src/app/provider.tsx | 0 .../src/components/copy-inline.tsx | 0 .../src/components/custom-tabs.tsx | 0 .../src/components/featurebase-icon.tsx | 0 .../src/components/inkeep-script.tsx | 0 .../src/components/inkeep-search.tsx | 0 .../src/components/mermaid.tsx | 0 .../src/components/page-actions.tsx | 0 .../src/components/search-dialog.tsx | 0 .../src/components/ui/button.tsx | 0 .../src/components/ui/popover.tsx | 0 packages/{qvac-docs => docs}/src/lib/cn.ts | 0 .../src/lib/custom-tree.ts | 0 .../src/lib/get-llm-text.ts | 0 .../src/lib/layout.shared.tsx | 0 .../src/lib/resolveIcon.ts | 0 .../{qvac-docs => docs}/src/lib/source.ts | 0 .../src/mdx-components.tsx | 0 packages/{qvac-docs => docs}/tsconfig.json | 0 .../qvac-sdk/test/mocks/changelog-tags.json | 6 +- 121 files changed, 103 insertions(+), 41 deletions(-) rename packages/{qvac-docs => docs}/.env.example (100%) rename packages/{qvac-docs => docs}/.gitignore (100%) rename packages/{qvac-docs => docs}/LICENSE (100%) rename packages/{qvac-docs => docs}/README.md (100%) rename packages/{qvac-docs => docs}/cli.json (100%) rename packages/{qvac-docs => docs}/content/docs/addons/embed-llamacpp/index.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/addons/index.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/addons/llm-llamacpp/index.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/addons/ocr-onnx/index.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/addons/transcription-whispercpp/index.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/addons/translation-nmtcpp/index.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/addons/tts-onnx/index.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/discover.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/flagship-apps.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/index.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/cancel.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/close.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/completion.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/deleteCache.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/downloadAsset.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/embed.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/getLogger.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/getModelByName.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/getModelBySrc.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/getModelInfo.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/index.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/loadModel.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/loggingStream.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/ocr.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/ping.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/ragDeleteEmbeddings.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/ragSaveEmbeddings.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/ragSearch.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/startQVACProvider.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/stopQVACProvider.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/textToSpeech.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/transcribe.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/transcribeStream.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/translate.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/api/latest/unloadModel.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/blind-relays.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/completion.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/configuration.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/delegated-inference.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/download-lifecycle.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/how-it-works.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/index.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/install.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/logging.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/multimodal.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/ocr.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/quickstart.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/rag.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/release-notes/v0-5.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/sharded-models.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/text-embeddings.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/text-to-speech.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/transcription.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/translation.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/tutorials/electron.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/tutorials/expo.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/sdk/tutorials/pear.mdx (100%) rename packages/{qvac-docs => docs}/content/docs/vision.mdx (100%) rename packages/{qvac-docs => docs}/next.config.mjs (100%) rename packages/{qvac-docs => docs}/package-lock.json (99%) rename packages/{qvac-docs => docs}/package.json (98%) rename packages/{qvac-docs => docs}/postcss.config.mjs (100%) rename packages/{qvac-docs => docs}/public/featurebase.svg (100%) rename packages/{qvac-docs => docs}/public/health.svg (100%) rename packages/{qvac-docs => docs}/public/keet.svg (100%) rename packages/{qvac-docs => docs}/public/llms.txt (100%) rename packages/{qvac-docs => docs}/public/pear.svg (100%) rename packages/{qvac-docs => docs}/public/qvac-favicon.ico (100%) rename packages/{qvac-docs => docs}/public/qvac-favicon.svg (100%) rename packages/{qvac-docs => docs}/public/qvac-logo.svg (100%) rename packages/{qvac-docs => docs}/public/screencasts/electron-tutorial-demo.webm (100%) rename packages/{qvac-docs => docs}/public/screencasts/pear-tutorial-demo.webm (100%) rename packages/{qvac-docs => docs}/public/screenshots/electron-window.png (100%) rename packages/{qvac-docs => docs}/public/screenshots/pear-task-completed.png (100%) rename packages/{qvac-docs => docs}/public/screenshots/pear-window.png (100%) rename packages/{qvac-docs => docs}/public/screenshots/tailwindcss.png (100%) rename packages/{qvac-docs => docs}/public/screenshots/task-completed.png (100%) rename packages/{qvac-docs => docs}/public/screenshots/ui-chat.png (100%) rename packages/{qvac-docs => docs}/public/screenshots/vite-renderer.png (100%) rename packages/{qvac-docs => docs}/public/workbench.svg (100%) rename packages/{qvac-docs => docs}/scripts/check-links.js (100%) rename packages/{qvac-docs => docs}/source.config.ts (100%) rename packages/{qvac-docs => docs}/src/app/(docs)/[[...slug]]/page.tsx (100%) rename packages/{qvac-docs => docs}/src/app/(docs)/layout.tsx (100%) rename packages/{qvac-docs => docs}/src/app/api/search/route.ts (100%) rename packages/{qvac-docs => docs}/src/app/global.css (100%) rename packages/{qvac-docs => docs}/src/app/layout.tsx (100%) rename packages/{qvac-docs => docs}/src/app/llms-full.txt/route.ts (100%) rename packages/{qvac-docs => docs}/src/app/provider.tsx (100%) rename packages/{qvac-docs => docs}/src/components/copy-inline.tsx (100%) rename packages/{qvac-docs => docs}/src/components/custom-tabs.tsx (100%) rename packages/{qvac-docs => docs}/src/components/featurebase-icon.tsx (100%) rename packages/{qvac-docs => docs}/src/components/inkeep-script.tsx (100%) rename packages/{qvac-docs => docs}/src/components/inkeep-search.tsx (100%) rename packages/{qvac-docs => docs}/src/components/mermaid.tsx (100%) rename packages/{qvac-docs => docs}/src/components/page-actions.tsx (100%) rename packages/{qvac-docs => docs}/src/components/search-dialog.tsx (100%) rename packages/{qvac-docs => docs}/src/components/ui/button.tsx (100%) rename packages/{qvac-docs => docs}/src/components/ui/popover.tsx (100%) rename packages/{qvac-docs => docs}/src/lib/cn.ts (100%) rename packages/{qvac-docs => docs}/src/lib/custom-tree.ts (100%) rename packages/{qvac-docs => docs}/src/lib/get-llm-text.ts (100%) rename packages/{qvac-docs => docs}/src/lib/layout.shared.tsx (100%) rename packages/{qvac-docs => docs}/src/lib/resolveIcon.ts (100%) rename packages/{qvac-docs => docs}/src/lib/source.ts (100%) rename packages/{qvac-docs => docs}/src/mdx-components.tsx (100%) rename packages/{qvac-docs => docs}/tsconfig.json (100%) diff --git a/.cursor/rules/sdk/commit-and-pr-format.mdc b/.cursor/rules/sdk/commit-and-pr-format.mdc index cd269f01b4..ac6c4e23d5 100644 --- a/.cursor/rules/sdk/commit-and-pr-format.mdc +++ b/.cursor/rules/sdk/commit-and-pr-format.mdc @@ -2,7 +2,7 @@ description: Commit message and PR title format requirements globs: - packages/qvac-sdk/** - - packages/qvac-docs/** + - packages/docs/** - packages/qvac-lib-rag/** - packages/qvac-lib-logging/** - packages/qvac-lib-error-base/** @@ -14,11 +14,13 @@ alwaysApply: false ## When suggesting or creating commits **ALWAYS use this format:** + ``` prefix[tags]?: subject ``` **Allowed prefixes:** + - `feat` - New features or capabilities - `fix` - Bug fixes - `doc` - Documentation changes @@ -27,6 +29,7 @@ prefix[tags]?: subject - `infra` - CI/CD, tooling, infrastructure **Allowed tags (optional, cannot be combined):** + - `[api]` - API changes (non-breaking) - `[bc]` - Breaking changes (including breaking API changes) - `[mod]` - Model changes (requires Models section with Added/Removed subsections) @@ -34,6 +37,7 @@ prefix[tags]?: subject - `[skiplog]` - skip changelog generation for the PR **Examples:** + - `feat: add RAG support for LanceDB` - `fix[api]: fix completion stream error handling` - `doc: update installation instructions` @@ -45,6 +49,7 @@ prefix[tags]?: subject ## When suggesting or creating PRs **ALWAYS use this format for PR titles:** + ``` TICKET prefix[tags]: subject ``` @@ -54,6 +59,7 @@ Where TICKET follows the pattern: `PROJECT-123` (e.g., `QVAC-123`, `SDK-456`) Use `[notask]` when omitting the ticket: `prefix[notask]: subject`. **Examples:** + - `QVAC-123 feat: add RAG support for LanceDB` - `QVAC-456 fix[api]: fix completion stream error handling` - `QVAC-789 doc: update installation instructions` @@ -63,37 +69,47 @@ Use `[notask]` when omitting the ticket: `prefix[notask]: subject`. ## Required PR Body Content **When using `[bc]` tag:** + - MUST include BEFORE/AFTER code examples in the PR body - Use either format: 1. Explicit markers: - ``` + + ```` **BEFORE:** ```typescript // old code - ``` - + ```` + **AFTER:** + ```typescript // new code ``` + + ``` + ``` + 2. Inline comments: + ```` ```typescript // old const model = await loadModel("model-path"); - + // new const modelId = await loadModel("model-path", { modelType: "llm" }); ``` ```` **When using `[api]` tag (non-breaking):** + - MUST include at least one fenced code block showing the new API usage - Example: + ```` ## New API - + ```typescript // New completion API with streaming support for await (const token of completion({ @@ -106,15 +122,17 @@ Use `[notask]` when omitting the ticket: `prefix[notask]: subject`. ```` **When using `[mod]` tag:** + - MUST include a Models section with at least one subsection: Added models or Removed models - Each subsection MUST contain a fenced code block listing model constant names (one per line) - Delete empty subsections instead of using `(none)` - Example: + ```` ## 📦 Models - + ### Added models - + ``` WHISPER_LARGE_V3_Q5_K LLAMA_3_8B_INST_Q4_K_M @@ -136,29 +154,34 @@ Use `[notask]` when omitting the ticket: `prefix[notask]: subject`. ## PR Description Quality Guidelines **General principles:** + - Be concise - prefer bullet points over prose - Focus on "why" not "what" - the diff shows what changed - Delete template sections that don't apply - Avoid vague statements like "improved performance" without specifics **"What problem does this PR solve?"** + - Describe the user-facing issue, bug, or need - NOT implementation details - Good: "Users couldn't load models larger than 4GB on Windows" - Bad: "The buffer allocation in loadModel was incorrect" **"How does it solve it?"** + - High-level approach, not line-by-line changes - Mention key design decisions if non-obvious - Good: "Switch to memory-mapped file loading with chunked reads" - Bad: "Changed line 45 to use mmap instead of readFile" **"How was it tested?"** + - Actual test scenarios, not just "I ran the tests" - Include: OS, model size, edge cases if relevant - Good: "Tested 8GB model on Windows 11, memory stayed under 1GB" - Bad: "Unit tests pass" **Avoid:** + - Implementation details obvious from the diff - Repeating commit messages verbatim - Unnecessary context the reviewer doesn't need diff --git a/.cursor/rules/sdk/sdk-pod-packages.mdc b/.cursor/rules/sdk/sdk-pod-packages.mdc index 4e9f2d23ef..3b11baa6d9 100644 --- a/.cursor/rules/sdk/sdk-pod-packages.mdc +++ b/.cursor/rules/sdk/sdk-pod-packages.mdc @@ -9,7 +9,7 @@ The following packages belong to the SDK pod: - `packages/qvac-sdk` - `packages/qvac-cli` -- `packages/qvac-docs` +- `packages/docs` - `packages/qvac-lib-rag` - `packages/qvac-lib-logging` - `packages/qvac-lib-error-base` @@ -24,7 +24,7 @@ For rules that need glob patterns: globs: - packages/qvac-sdk/** - packages/qvac-cli/** - - packages/qvac-docs/** + - packages/docs/** - packages/qvac-lib-rag/** - packages/qvac-lib-logging/** - packages/qvac-lib-error-base/** @@ -33,6 +33,7 @@ globs: ## Skill Naming Convention Skills for SDK pod should use the `sdk-` prefix: + - `sdk-pr-create` - `sdk-changelog` - `sdk-release` diff --git a/.cursor/rules/sdk/skill-authoring-guidelines.mdc b/.cursor/rules/sdk/skill-authoring-guidelines.mdc index 9c32e73d92..26ddc54c3d 100644 --- a/.cursor/rules/sdk/skill-authoring-guidelines.mdc +++ b/.cursor/rules/sdk/skill-authoring-guidelines.mdc @@ -26,12 +26,14 @@ Guidelines for creating effective Cursor skills, based on the [Agent Skills spec ## Naming Convention **Use pod prefix for skill directories:** + - SDK pod skills: `sdk-pr-create`, `sdk-changelog`, `sdk-release` - Other pods: `infra-deploy`, `platform-migration` **If pod is unclear, ask the user.** **Skill name requirements:** + - Max 64 characters - Lowercase letters, numbers, and hyphens only - No consecutive hyphens (`--`) @@ -39,6 +41,7 @@ Guidelines for creating effective Cursor skills, based on the [Agent Skills spec - Must match parent directory name **Prefer gerund form or action-oriented names:** + - Good: `processing-pdfs`, `analyzing-data`, `sdk-pr-create` - Avoid: `helper`, `utils`, `tools` @@ -53,11 +56,11 @@ description: What the skill does and when to use it. ### Optional Frontmatter Fields -| Field | Purpose | -|-------|---------| -| `license` | License name or reference | -| `compatibility` | Environment requirements | -| `metadata` | Arbitrary key-value pairs | +| Field | Purpose | +| -------------------------- | --------------------------------- | +| `license` | License name or reference | +| `compatibility` | Environment requirements | +| `metadata` | Arbitrary key-value pairs | | `disable-model-invocation` | Set `true` for manual-only skills | ## Manual-Only Skills @@ -79,18 +82,22 @@ Document this clearly in the description so users know to invoke manually. The description is critical for skill discovery. **Write in third person** (injected into system prompt): + - Good: "Generates PR descriptions for SDK pod packages" - Bad: "I help you create PR descriptions" - Bad: "You can use this to create PRs" **Include WHAT and WHEN:** + - WHAT: What the skill does (specific capabilities) - WHEN: When to use it (trigger scenarios, keywords) **Example:** + ```yaml -description: Generate PR descriptions for SDK pod packages following template and - format rules. Use when creating PRs for qvac-sdk, qvac-docs, qvac-lib-rag, +description: + Generate PR descriptions for SDK pod packages following template and + format rules. Use when creating PRs for qvac-sdk, docs, qvac-lib-rag, qvac-lib-logging, or qvac-lib-error-base. ``` @@ -106,20 +113,24 @@ Brief one-line description. ## When to use this skill **Applies to SDK pod packages:** + - packages/qvac-sdk -- packages/qvac-docs +- packages/docs - packages/qvac-lib-rag - packages/qvac-lib-logging - packages/qvac-lib-error-base **Use when:** + - The user asks to... - Working with... **Do NOT use for:** + - (common confusion cases, if any) ## Instructions + ... ``` @@ -132,6 +143,7 @@ The context window is shared. Be concise. **Default assumption:** The agent is already smart. Only add context it doesn't have. Challenge each piece of information: + - "Does the agent really need this explanation?" - "Can I assume the agent knows this?" - "Does this paragraph justify its token cost?" @@ -144,9 +156,11 @@ Put essential info in SKILL.md; detailed content in `references/` loaded on dema # My Skill ## Quick start + [Essential instructions here] ## Additional resources + - For complete API details, see [references/REFERENCE.md](references/REFERENCE.md) - For usage examples, see [references/examples.md](references/examples.md) ``` @@ -168,9 +182,11 @@ Use this template: # [Title] ## Summary + [One paragraph] ## Details + - Point 1 - Point 2 ``` @@ -227,18 +243,21 @@ For quality-critical tasks: Skills can include a `scripts/` directory with executable code the agent can run. **When to use scripts:** + - Validation/verification steps - Complex data transformations - Operations that need consistency across runs - Tasks where generated code would be unreliable **Benefits over generated code:** + - More reliable than ad-hoc generated code - Save tokens (script not loaded into context, only output) - Ensure consistency across uses - Can be tested and versioned **Reference scripts in SKILL.md:** + ```markdown ## Validation @@ -249,10 +268,12 @@ If validation fails, review errors and fix before continuing. ``` **Make intent clear** - whether agent should **execute** or **read**: + - "Run `scripts/validate.py` to check output" (execute) - "See `scripts/validate.py` for the algorithm" (read as reference) **Script requirements:** + - Self-contained or clearly document dependencies - Include helpful error messages - Handle edge cases gracefully @@ -261,29 +282,38 @@ If validation fails, review errors and fix before continuing. ## Anti-Patterns to Avoid ### Windows-Style Paths + - Good: `scripts/helper.py` - Bad: `scripts\helper.py` ### Too Many Options + ```markdown # Bad - confusing + "You can use library A, or B, or C, or D..." # Good - provide default with escape hatch + "Use library A for this task. For edge case X, use library B instead." ``` ### Time-Sensitive Information + ```markdown # Bad - will become outdated + "If before August 2025, use old API" # Good - use deprecated section + ## Current method + Use v2 API. ## Deprecated (old patterns) +
Legacy v1 API ... @@ -291,11 +321,14 @@ Use v2 API. ``` ### Inconsistent Terminology + Choose one term and use it throughout: + - Good: Always "API endpoint" - Bad: Mix "endpoint", "URL", "route", "path" ### Vague Skill Names + - Good: `sdk-pr-create`, `processing-pdfs` - Bad: `helper`, `utils`, `stuff` @@ -303,17 +336,18 @@ Choose one term and use it throughout: Match specificity to task fragility: -| Freedom | When to Use | Example | -|---------|-------------|---------| -| High (text instructions) | Multiple valid approaches | Code review guidelines | -| Medium (templates) | Preferred pattern with variation | Report generation | -| Low (exact scripts) | Fragile operations, consistency critical | Database migrations | +| Freedom | When to Use | Example | +| ------------------------ | ---------------------------------------- | ---------------------- | +| High (text instructions) | Multiple valid approaches | Code review guidelines | +| Medium (templates) | Preferred pattern with variation | Report generation | +| Low (exact scripts) | Fragile operations, consistency critical | Database migrations | ## Quality Checklist Before finalizing a skill: ### Core Quality + - [ ] Description is specific with trigger terms - [ ] Description includes WHAT and WHEN - [ ] Written in third person @@ -322,12 +356,14 @@ Before finalizing a skill: - [ ] Examples are concrete, not abstract ### Structure + - [ ] File references one level deep - [ ] Progressive disclosure used appropriately - [ ] Workflows have clear steps - [ ] No time-sensitive information ### If Including Scripts + - [ ] Scripts handle errors explicitly - [ ] Required packages documented - [ ] No Windows-style paths diff --git a/.cursor/skills/sdk-changelog/SKILL.md b/.cursor/skills/sdk-changelog/SKILL.md index c970109b4f..886fa52a01 100644 --- a/.cursor/skills/sdk-changelog/SKILL.md +++ b/.cursor/skills/sdk-changelog/SKILL.md @@ -12,6 +12,7 @@ Generate changelogs for SDK pod packages following the monorepo GitFlow. **Applies to SDK pod packages** as defined in `.cursor/rules/sdk/sdk-pod-packages.mdc`. **Use when:** + - Preparing a release for any SDK pod package - User asks to generate changelog - User asks to create human-readable/presentable changelog @@ -52,12 +53,12 @@ See [references/changelog-llm-format.md](references/changelog-llm-format.md) for ## CLI Parameters -| Flag | Required | Description | -|------|----------|-------------| -| `--package` | Yes | Package name (e.g., `qvac-sdk`) | -| `--base-commit` | No | Initial commit SHA for migration (overrides tag lookup) | -| `--base-version` | No | Version label for base commit (display only) | -| `--dry-run` | No | Preview output without writing files | +| Flag | Required | Description | +| ---------------- | -------- | ------------------------------------------------------- | +| `--package` | Yes | Package name (e.g., `qvac-sdk`) | +| `--base-commit` | No | Initial commit SHA for migration (overrides tag lookup) | +| `--base-version` | No | Version label for base commit (display only) | +| `--dry-run` | No | Preview output without writing files | ## Output @@ -74,8 +75,9 @@ Generates changelog files in `packages//changelog//`: Tags follow the pattern: `-v` Examples: + - `qvac-sdk-v1.0.0` -- `qvac-docs-v0.1.0` +- `docs-v0.1.0` - `qvac-lib-rag-v2.0.0` ## Quality Checklist diff --git a/.github/sdk-pod-checks.json b/.github/sdk-pod-checks.json index 924f1b5276..5bc3c090cc 100644 --- a/.github/sdk-pod-checks.json +++ b/.github/sdk-pod-checks.json @@ -21,7 +21,7 @@ "path": "packages/qvac-lib-error-base" }, { - "package": "qvac-docs", - "path": "packages/qvac-docs" + "package": "docs", + "path": "packages/docs" } ] diff --git a/.github/workflows/pr-checks-sdk-pod.yml b/.github/workflows/pr-checks-sdk-pod.yml index e28dc2d89f..4f12a9e2fa 100644 --- a/.github/workflows/pr-checks-sdk-pod.yml +++ b/.github/workflows/pr-checks-sdk-pod.yml @@ -13,7 +13,7 @@ on: - "packages/qvac-lib-rag/**" - "packages/qvac-lib-logging/**" - "packages/qvac-lib-error-base/**" - - "packages/qvac-docs/**" + - "packages/docs/**" branches: - main - release-* diff --git a/.github/workflows/pr-validation-sdk-pod.yml b/.github/workflows/pr-validation-sdk-pod.yml index a3cd37930a..b73007f2b9 100644 --- a/.github/workflows/pr-validation-sdk-pod.yml +++ b/.github/workflows/pr-validation-sdk-pod.yml @@ -10,7 +10,7 @@ on: paths: - "packages/qvac-sdk/**" - "packages/qvac-cli/**" - - "packages/qvac-docs/**" + - "packages/docs/**" - "packages/qvac-lib-rag/**" - "packages/qvac-lib-logging/**" - "packages/qvac-lib-error-base/**" diff --git a/.github/workflows/repository-dispatch-qvac-sdk.yml b/.github/workflows/repository-dispatch-qvac-sdk.yml index 674b2fbefb..74d2ac49ef 100644 --- a/.github/workflows/repository-dispatch-qvac-sdk.yml +++ b/.github/workflows/repository-dispatch-qvac-sdk.yml @@ -25,7 +25,7 @@ jobs: shell: bash env: MERGE_SHA: ${{ github.event.pull_request.merge_commit_sha }} - BASE_SHA: ${{ github.event.pull_request.base.sha }} + BASE_SHA: ${{ github.event.pull_request.base.sha }} WORKDIR: ${{ env.WORKDIR }} run: | set -euo pipefail diff --git a/packages/qvac-docs/.env.example b/packages/docs/.env.example similarity index 100% rename from packages/qvac-docs/.env.example rename to packages/docs/.env.example diff --git a/packages/qvac-docs/.gitignore b/packages/docs/.gitignore similarity index 100% rename from packages/qvac-docs/.gitignore rename to packages/docs/.gitignore diff --git a/packages/qvac-docs/LICENSE b/packages/docs/LICENSE similarity index 100% rename from packages/qvac-docs/LICENSE rename to packages/docs/LICENSE diff --git a/packages/qvac-docs/README.md b/packages/docs/README.md similarity index 100% rename from packages/qvac-docs/README.md rename to packages/docs/README.md diff --git a/packages/qvac-docs/cli.json b/packages/docs/cli.json similarity index 100% rename from packages/qvac-docs/cli.json rename to packages/docs/cli.json diff --git a/packages/qvac-docs/content/docs/addons/embed-llamacpp/index.mdx b/packages/docs/content/docs/addons/embed-llamacpp/index.mdx similarity index 100% rename from packages/qvac-docs/content/docs/addons/embed-llamacpp/index.mdx rename to packages/docs/content/docs/addons/embed-llamacpp/index.mdx diff --git a/packages/qvac-docs/content/docs/addons/index.mdx b/packages/docs/content/docs/addons/index.mdx similarity index 100% rename from packages/qvac-docs/content/docs/addons/index.mdx rename to packages/docs/content/docs/addons/index.mdx diff --git a/packages/qvac-docs/content/docs/addons/llm-llamacpp/index.mdx b/packages/docs/content/docs/addons/llm-llamacpp/index.mdx similarity index 100% rename from packages/qvac-docs/content/docs/addons/llm-llamacpp/index.mdx rename to packages/docs/content/docs/addons/llm-llamacpp/index.mdx diff --git a/packages/qvac-docs/content/docs/addons/ocr-onnx/index.mdx b/packages/docs/content/docs/addons/ocr-onnx/index.mdx similarity index 100% rename from packages/qvac-docs/content/docs/addons/ocr-onnx/index.mdx rename to packages/docs/content/docs/addons/ocr-onnx/index.mdx diff --git a/packages/qvac-docs/content/docs/addons/transcription-whispercpp/index.mdx b/packages/docs/content/docs/addons/transcription-whispercpp/index.mdx similarity index 100% rename from packages/qvac-docs/content/docs/addons/transcription-whispercpp/index.mdx rename to packages/docs/content/docs/addons/transcription-whispercpp/index.mdx diff --git a/packages/qvac-docs/content/docs/addons/translation-nmtcpp/index.mdx b/packages/docs/content/docs/addons/translation-nmtcpp/index.mdx similarity index 100% rename from packages/qvac-docs/content/docs/addons/translation-nmtcpp/index.mdx rename to packages/docs/content/docs/addons/translation-nmtcpp/index.mdx diff --git a/packages/qvac-docs/content/docs/addons/tts-onnx/index.mdx b/packages/docs/content/docs/addons/tts-onnx/index.mdx similarity index 100% rename from packages/qvac-docs/content/docs/addons/tts-onnx/index.mdx rename to packages/docs/content/docs/addons/tts-onnx/index.mdx diff --git a/packages/qvac-docs/content/docs/discover.mdx b/packages/docs/content/docs/discover.mdx similarity index 100% rename from packages/qvac-docs/content/docs/discover.mdx rename to packages/docs/content/docs/discover.mdx diff --git a/packages/qvac-docs/content/docs/flagship-apps.mdx b/packages/docs/content/docs/flagship-apps.mdx similarity index 100% rename from packages/qvac-docs/content/docs/flagship-apps.mdx rename to packages/docs/content/docs/flagship-apps.mdx diff --git a/packages/qvac-docs/content/docs/index.mdx b/packages/docs/content/docs/index.mdx similarity index 100% rename from packages/qvac-docs/content/docs/index.mdx rename to packages/docs/content/docs/index.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/cancel.mdx b/packages/docs/content/docs/sdk/api/latest/cancel.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/cancel.mdx rename to packages/docs/content/docs/sdk/api/latest/cancel.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/close.mdx b/packages/docs/content/docs/sdk/api/latest/close.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/close.mdx rename to packages/docs/content/docs/sdk/api/latest/close.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/completion.mdx b/packages/docs/content/docs/sdk/api/latest/completion.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/completion.mdx rename to packages/docs/content/docs/sdk/api/latest/completion.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/deleteCache.mdx b/packages/docs/content/docs/sdk/api/latest/deleteCache.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/deleteCache.mdx rename to packages/docs/content/docs/sdk/api/latest/deleteCache.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/downloadAsset.mdx b/packages/docs/content/docs/sdk/api/latest/downloadAsset.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/downloadAsset.mdx rename to packages/docs/content/docs/sdk/api/latest/downloadAsset.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/embed.mdx b/packages/docs/content/docs/sdk/api/latest/embed.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/embed.mdx rename to packages/docs/content/docs/sdk/api/latest/embed.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/getLogger.mdx b/packages/docs/content/docs/sdk/api/latest/getLogger.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/getLogger.mdx rename to packages/docs/content/docs/sdk/api/latest/getLogger.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/getModelByName.mdx b/packages/docs/content/docs/sdk/api/latest/getModelByName.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/getModelByName.mdx rename to packages/docs/content/docs/sdk/api/latest/getModelByName.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/getModelBySrc.mdx b/packages/docs/content/docs/sdk/api/latest/getModelBySrc.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/getModelBySrc.mdx rename to packages/docs/content/docs/sdk/api/latest/getModelBySrc.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/getModelInfo.mdx b/packages/docs/content/docs/sdk/api/latest/getModelInfo.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/getModelInfo.mdx rename to packages/docs/content/docs/sdk/api/latest/getModelInfo.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/index.mdx b/packages/docs/content/docs/sdk/api/latest/index.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/index.mdx rename to packages/docs/content/docs/sdk/api/latest/index.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/loadModel.mdx b/packages/docs/content/docs/sdk/api/latest/loadModel.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/loadModel.mdx rename to packages/docs/content/docs/sdk/api/latest/loadModel.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/loggingStream.mdx b/packages/docs/content/docs/sdk/api/latest/loggingStream.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/loggingStream.mdx rename to packages/docs/content/docs/sdk/api/latest/loggingStream.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/ocr.mdx b/packages/docs/content/docs/sdk/api/latest/ocr.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/ocr.mdx rename to packages/docs/content/docs/sdk/api/latest/ocr.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/ping.mdx b/packages/docs/content/docs/sdk/api/latest/ping.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/ping.mdx rename to packages/docs/content/docs/sdk/api/latest/ping.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/ragDeleteEmbeddings.mdx b/packages/docs/content/docs/sdk/api/latest/ragDeleteEmbeddings.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/ragDeleteEmbeddings.mdx rename to packages/docs/content/docs/sdk/api/latest/ragDeleteEmbeddings.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/ragSaveEmbeddings.mdx b/packages/docs/content/docs/sdk/api/latest/ragSaveEmbeddings.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/ragSaveEmbeddings.mdx rename to packages/docs/content/docs/sdk/api/latest/ragSaveEmbeddings.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/ragSearch.mdx b/packages/docs/content/docs/sdk/api/latest/ragSearch.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/ragSearch.mdx rename to packages/docs/content/docs/sdk/api/latest/ragSearch.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/startQVACProvider.mdx b/packages/docs/content/docs/sdk/api/latest/startQVACProvider.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/startQVACProvider.mdx rename to packages/docs/content/docs/sdk/api/latest/startQVACProvider.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/stopQVACProvider.mdx b/packages/docs/content/docs/sdk/api/latest/stopQVACProvider.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/stopQVACProvider.mdx rename to packages/docs/content/docs/sdk/api/latest/stopQVACProvider.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/textToSpeech.mdx b/packages/docs/content/docs/sdk/api/latest/textToSpeech.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/textToSpeech.mdx rename to packages/docs/content/docs/sdk/api/latest/textToSpeech.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/transcribe.mdx b/packages/docs/content/docs/sdk/api/latest/transcribe.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/transcribe.mdx rename to packages/docs/content/docs/sdk/api/latest/transcribe.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/transcribeStream.mdx b/packages/docs/content/docs/sdk/api/latest/transcribeStream.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/transcribeStream.mdx rename to packages/docs/content/docs/sdk/api/latest/transcribeStream.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/translate.mdx b/packages/docs/content/docs/sdk/api/latest/translate.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/translate.mdx rename to packages/docs/content/docs/sdk/api/latest/translate.mdx diff --git a/packages/qvac-docs/content/docs/sdk/api/latest/unloadModel.mdx b/packages/docs/content/docs/sdk/api/latest/unloadModel.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/api/latest/unloadModel.mdx rename to packages/docs/content/docs/sdk/api/latest/unloadModel.mdx diff --git a/packages/qvac-docs/content/docs/sdk/blind-relays.mdx b/packages/docs/content/docs/sdk/blind-relays.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/blind-relays.mdx rename to packages/docs/content/docs/sdk/blind-relays.mdx diff --git a/packages/qvac-docs/content/docs/sdk/completion.mdx b/packages/docs/content/docs/sdk/completion.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/completion.mdx rename to packages/docs/content/docs/sdk/completion.mdx diff --git a/packages/qvac-docs/content/docs/sdk/configuration.mdx b/packages/docs/content/docs/sdk/configuration.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/configuration.mdx rename to packages/docs/content/docs/sdk/configuration.mdx diff --git a/packages/qvac-docs/content/docs/sdk/delegated-inference.mdx b/packages/docs/content/docs/sdk/delegated-inference.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/delegated-inference.mdx rename to packages/docs/content/docs/sdk/delegated-inference.mdx diff --git a/packages/qvac-docs/content/docs/sdk/download-lifecycle.mdx b/packages/docs/content/docs/sdk/download-lifecycle.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/download-lifecycle.mdx rename to packages/docs/content/docs/sdk/download-lifecycle.mdx diff --git a/packages/qvac-docs/content/docs/sdk/how-it-works.mdx b/packages/docs/content/docs/sdk/how-it-works.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/how-it-works.mdx rename to packages/docs/content/docs/sdk/how-it-works.mdx diff --git a/packages/qvac-docs/content/docs/sdk/index.mdx b/packages/docs/content/docs/sdk/index.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/index.mdx rename to packages/docs/content/docs/sdk/index.mdx diff --git a/packages/qvac-docs/content/docs/sdk/install.mdx b/packages/docs/content/docs/sdk/install.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/install.mdx rename to packages/docs/content/docs/sdk/install.mdx diff --git a/packages/qvac-docs/content/docs/sdk/logging.mdx b/packages/docs/content/docs/sdk/logging.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/logging.mdx rename to packages/docs/content/docs/sdk/logging.mdx diff --git a/packages/qvac-docs/content/docs/sdk/multimodal.mdx b/packages/docs/content/docs/sdk/multimodal.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/multimodal.mdx rename to packages/docs/content/docs/sdk/multimodal.mdx diff --git a/packages/qvac-docs/content/docs/sdk/ocr.mdx b/packages/docs/content/docs/sdk/ocr.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/ocr.mdx rename to packages/docs/content/docs/sdk/ocr.mdx diff --git a/packages/qvac-docs/content/docs/sdk/quickstart.mdx b/packages/docs/content/docs/sdk/quickstart.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/quickstart.mdx rename to packages/docs/content/docs/sdk/quickstart.mdx diff --git a/packages/qvac-docs/content/docs/sdk/rag.mdx b/packages/docs/content/docs/sdk/rag.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/rag.mdx rename to packages/docs/content/docs/sdk/rag.mdx diff --git a/packages/qvac-docs/content/docs/sdk/release-notes/v0-5.mdx b/packages/docs/content/docs/sdk/release-notes/v0-5.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/release-notes/v0-5.mdx rename to packages/docs/content/docs/sdk/release-notes/v0-5.mdx diff --git a/packages/qvac-docs/content/docs/sdk/sharded-models.mdx b/packages/docs/content/docs/sdk/sharded-models.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/sharded-models.mdx rename to packages/docs/content/docs/sdk/sharded-models.mdx diff --git a/packages/qvac-docs/content/docs/sdk/text-embeddings.mdx b/packages/docs/content/docs/sdk/text-embeddings.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/text-embeddings.mdx rename to packages/docs/content/docs/sdk/text-embeddings.mdx diff --git a/packages/qvac-docs/content/docs/sdk/text-to-speech.mdx b/packages/docs/content/docs/sdk/text-to-speech.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/text-to-speech.mdx rename to packages/docs/content/docs/sdk/text-to-speech.mdx diff --git a/packages/qvac-docs/content/docs/sdk/transcription.mdx b/packages/docs/content/docs/sdk/transcription.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/transcription.mdx rename to packages/docs/content/docs/sdk/transcription.mdx diff --git a/packages/qvac-docs/content/docs/sdk/translation.mdx b/packages/docs/content/docs/sdk/translation.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/translation.mdx rename to packages/docs/content/docs/sdk/translation.mdx diff --git a/packages/qvac-docs/content/docs/sdk/tutorials/electron.mdx b/packages/docs/content/docs/sdk/tutorials/electron.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/tutorials/electron.mdx rename to packages/docs/content/docs/sdk/tutorials/electron.mdx diff --git a/packages/qvac-docs/content/docs/sdk/tutorials/expo.mdx b/packages/docs/content/docs/sdk/tutorials/expo.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/tutorials/expo.mdx rename to packages/docs/content/docs/sdk/tutorials/expo.mdx diff --git a/packages/qvac-docs/content/docs/sdk/tutorials/pear.mdx b/packages/docs/content/docs/sdk/tutorials/pear.mdx similarity index 100% rename from packages/qvac-docs/content/docs/sdk/tutorials/pear.mdx rename to packages/docs/content/docs/sdk/tutorials/pear.mdx diff --git a/packages/qvac-docs/content/docs/vision.mdx b/packages/docs/content/docs/vision.mdx similarity index 100% rename from packages/qvac-docs/content/docs/vision.mdx rename to packages/docs/content/docs/vision.mdx diff --git a/packages/qvac-docs/next.config.mjs b/packages/docs/next.config.mjs similarity index 100% rename from packages/qvac-docs/next.config.mjs rename to packages/docs/next.config.mjs diff --git a/packages/qvac-docs/package-lock.json b/packages/docs/package-lock.json similarity index 99% rename from packages/qvac-docs/package-lock.json rename to packages/docs/package-lock.json index 257cd56e58..0db9b0f586 100644 --- a/packages/qvac-docs/package-lock.json +++ b/packages/docs/package-lock.json @@ -1,11 +1,11 @@ { - "name": "qvac-docs", + "name": "docs", "version": "0.1.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "qvac-docs", + "name": "docs", "version": "0.1.0", "hasInstallScript": true, "dependencies": { diff --git a/packages/qvac-docs/package.json b/packages/docs/package.json similarity index 98% rename from packages/qvac-docs/package.json rename to packages/docs/package.json index 7ef4bf02b4..6eb61fd23e 100644 --- a/packages/qvac-docs/package.json +++ b/packages/docs/package.json @@ -1,5 +1,5 @@ { - "name": "qvac-docs", + "name": "docs", "version": "0.1.0", "description": "Official documentation and single source of truth for QVAC", "private": true, diff --git a/packages/qvac-docs/postcss.config.mjs b/packages/docs/postcss.config.mjs similarity index 100% rename from packages/qvac-docs/postcss.config.mjs rename to packages/docs/postcss.config.mjs diff --git a/packages/qvac-docs/public/featurebase.svg b/packages/docs/public/featurebase.svg similarity index 100% rename from packages/qvac-docs/public/featurebase.svg rename to packages/docs/public/featurebase.svg diff --git a/packages/qvac-docs/public/health.svg b/packages/docs/public/health.svg similarity index 100% rename from packages/qvac-docs/public/health.svg rename to packages/docs/public/health.svg diff --git a/packages/qvac-docs/public/keet.svg b/packages/docs/public/keet.svg similarity index 100% rename from packages/qvac-docs/public/keet.svg rename to packages/docs/public/keet.svg diff --git a/packages/qvac-docs/public/llms.txt b/packages/docs/public/llms.txt similarity index 100% rename from packages/qvac-docs/public/llms.txt rename to packages/docs/public/llms.txt diff --git a/packages/qvac-docs/public/pear.svg b/packages/docs/public/pear.svg similarity index 100% rename from packages/qvac-docs/public/pear.svg rename to packages/docs/public/pear.svg diff --git a/packages/qvac-docs/public/qvac-favicon.ico b/packages/docs/public/qvac-favicon.ico similarity index 100% rename from packages/qvac-docs/public/qvac-favicon.ico rename to packages/docs/public/qvac-favicon.ico diff --git a/packages/qvac-docs/public/qvac-favicon.svg b/packages/docs/public/qvac-favicon.svg similarity index 100% rename from packages/qvac-docs/public/qvac-favicon.svg rename to packages/docs/public/qvac-favicon.svg diff --git a/packages/qvac-docs/public/qvac-logo.svg b/packages/docs/public/qvac-logo.svg similarity index 100% rename from packages/qvac-docs/public/qvac-logo.svg rename to packages/docs/public/qvac-logo.svg diff --git a/packages/qvac-docs/public/screencasts/electron-tutorial-demo.webm b/packages/docs/public/screencasts/electron-tutorial-demo.webm similarity index 100% rename from packages/qvac-docs/public/screencasts/electron-tutorial-demo.webm rename to packages/docs/public/screencasts/electron-tutorial-demo.webm diff --git a/packages/qvac-docs/public/screencasts/pear-tutorial-demo.webm b/packages/docs/public/screencasts/pear-tutorial-demo.webm similarity index 100% rename from packages/qvac-docs/public/screencasts/pear-tutorial-demo.webm rename to packages/docs/public/screencasts/pear-tutorial-demo.webm diff --git a/packages/qvac-docs/public/screenshots/electron-window.png b/packages/docs/public/screenshots/electron-window.png similarity index 100% rename from packages/qvac-docs/public/screenshots/electron-window.png rename to packages/docs/public/screenshots/electron-window.png diff --git a/packages/qvac-docs/public/screenshots/pear-task-completed.png b/packages/docs/public/screenshots/pear-task-completed.png similarity index 100% rename from packages/qvac-docs/public/screenshots/pear-task-completed.png rename to packages/docs/public/screenshots/pear-task-completed.png diff --git a/packages/qvac-docs/public/screenshots/pear-window.png b/packages/docs/public/screenshots/pear-window.png similarity index 100% rename from packages/qvac-docs/public/screenshots/pear-window.png rename to packages/docs/public/screenshots/pear-window.png diff --git a/packages/qvac-docs/public/screenshots/tailwindcss.png b/packages/docs/public/screenshots/tailwindcss.png similarity index 100% rename from packages/qvac-docs/public/screenshots/tailwindcss.png rename to packages/docs/public/screenshots/tailwindcss.png diff --git a/packages/qvac-docs/public/screenshots/task-completed.png b/packages/docs/public/screenshots/task-completed.png similarity index 100% rename from packages/qvac-docs/public/screenshots/task-completed.png rename to packages/docs/public/screenshots/task-completed.png diff --git a/packages/qvac-docs/public/screenshots/ui-chat.png b/packages/docs/public/screenshots/ui-chat.png similarity index 100% rename from packages/qvac-docs/public/screenshots/ui-chat.png rename to packages/docs/public/screenshots/ui-chat.png diff --git a/packages/qvac-docs/public/screenshots/vite-renderer.png b/packages/docs/public/screenshots/vite-renderer.png similarity index 100% rename from packages/qvac-docs/public/screenshots/vite-renderer.png rename to packages/docs/public/screenshots/vite-renderer.png diff --git a/packages/qvac-docs/public/workbench.svg b/packages/docs/public/workbench.svg similarity index 100% rename from packages/qvac-docs/public/workbench.svg rename to packages/docs/public/workbench.svg diff --git a/packages/qvac-docs/scripts/check-links.js b/packages/docs/scripts/check-links.js similarity index 100% rename from packages/qvac-docs/scripts/check-links.js rename to packages/docs/scripts/check-links.js diff --git a/packages/qvac-docs/source.config.ts b/packages/docs/source.config.ts similarity index 100% rename from packages/qvac-docs/source.config.ts rename to packages/docs/source.config.ts diff --git a/packages/qvac-docs/src/app/(docs)/[[...slug]]/page.tsx b/packages/docs/src/app/(docs)/[[...slug]]/page.tsx similarity index 100% rename from packages/qvac-docs/src/app/(docs)/[[...slug]]/page.tsx rename to packages/docs/src/app/(docs)/[[...slug]]/page.tsx diff --git a/packages/qvac-docs/src/app/(docs)/layout.tsx b/packages/docs/src/app/(docs)/layout.tsx similarity index 100% rename from packages/qvac-docs/src/app/(docs)/layout.tsx rename to packages/docs/src/app/(docs)/layout.tsx diff --git a/packages/qvac-docs/src/app/api/search/route.ts b/packages/docs/src/app/api/search/route.ts similarity index 100% rename from packages/qvac-docs/src/app/api/search/route.ts rename to packages/docs/src/app/api/search/route.ts diff --git a/packages/qvac-docs/src/app/global.css b/packages/docs/src/app/global.css similarity index 100% rename from packages/qvac-docs/src/app/global.css rename to packages/docs/src/app/global.css diff --git a/packages/qvac-docs/src/app/layout.tsx b/packages/docs/src/app/layout.tsx similarity index 100% rename from packages/qvac-docs/src/app/layout.tsx rename to packages/docs/src/app/layout.tsx diff --git a/packages/qvac-docs/src/app/llms-full.txt/route.ts b/packages/docs/src/app/llms-full.txt/route.ts similarity index 100% rename from packages/qvac-docs/src/app/llms-full.txt/route.ts rename to packages/docs/src/app/llms-full.txt/route.ts diff --git a/packages/qvac-docs/src/app/provider.tsx b/packages/docs/src/app/provider.tsx similarity index 100% rename from packages/qvac-docs/src/app/provider.tsx rename to packages/docs/src/app/provider.tsx diff --git a/packages/qvac-docs/src/components/copy-inline.tsx b/packages/docs/src/components/copy-inline.tsx similarity index 100% rename from packages/qvac-docs/src/components/copy-inline.tsx rename to packages/docs/src/components/copy-inline.tsx diff --git a/packages/qvac-docs/src/components/custom-tabs.tsx b/packages/docs/src/components/custom-tabs.tsx similarity index 100% rename from packages/qvac-docs/src/components/custom-tabs.tsx rename to packages/docs/src/components/custom-tabs.tsx diff --git a/packages/qvac-docs/src/components/featurebase-icon.tsx b/packages/docs/src/components/featurebase-icon.tsx similarity index 100% rename from packages/qvac-docs/src/components/featurebase-icon.tsx rename to packages/docs/src/components/featurebase-icon.tsx diff --git a/packages/qvac-docs/src/components/inkeep-script.tsx b/packages/docs/src/components/inkeep-script.tsx similarity index 100% rename from packages/qvac-docs/src/components/inkeep-script.tsx rename to packages/docs/src/components/inkeep-script.tsx diff --git a/packages/qvac-docs/src/components/inkeep-search.tsx b/packages/docs/src/components/inkeep-search.tsx similarity index 100% rename from packages/qvac-docs/src/components/inkeep-search.tsx rename to packages/docs/src/components/inkeep-search.tsx diff --git a/packages/qvac-docs/src/components/mermaid.tsx b/packages/docs/src/components/mermaid.tsx similarity index 100% rename from packages/qvac-docs/src/components/mermaid.tsx rename to packages/docs/src/components/mermaid.tsx diff --git a/packages/qvac-docs/src/components/page-actions.tsx b/packages/docs/src/components/page-actions.tsx similarity index 100% rename from packages/qvac-docs/src/components/page-actions.tsx rename to packages/docs/src/components/page-actions.tsx diff --git a/packages/qvac-docs/src/components/search-dialog.tsx b/packages/docs/src/components/search-dialog.tsx similarity index 100% rename from packages/qvac-docs/src/components/search-dialog.tsx rename to packages/docs/src/components/search-dialog.tsx diff --git a/packages/qvac-docs/src/components/ui/button.tsx b/packages/docs/src/components/ui/button.tsx similarity index 100% rename from packages/qvac-docs/src/components/ui/button.tsx rename to packages/docs/src/components/ui/button.tsx diff --git a/packages/qvac-docs/src/components/ui/popover.tsx b/packages/docs/src/components/ui/popover.tsx similarity index 100% rename from packages/qvac-docs/src/components/ui/popover.tsx rename to packages/docs/src/components/ui/popover.tsx diff --git a/packages/qvac-docs/src/lib/cn.ts b/packages/docs/src/lib/cn.ts similarity index 100% rename from packages/qvac-docs/src/lib/cn.ts rename to packages/docs/src/lib/cn.ts diff --git a/packages/qvac-docs/src/lib/custom-tree.ts b/packages/docs/src/lib/custom-tree.ts similarity index 100% rename from packages/qvac-docs/src/lib/custom-tree.ts rename to packages/docs/src/lib/custom-tree.ts diff --git a/packages/qvac-docs/src/lib/get-llm-text.ts b/packages/docs/src/lib/get-llm-text.ts similarity index 100% rename from packages/qvac-docs/src/lib/get-llm-text.ts rename to packages/docs/src/lib/get-llm-text.ts diff --git a/packages/qvac-docs/src/lib/layout.shared.tsx b/packages/docs/src/lib/layout.shared.tsx similarity index 100% rename from packages/qvac-docs/src/lib/layout.shared.tsx rename to packages/docs/src/lib/layout.shared.tsx diff --git a/packages/qvac-docs/src/lib/resolveIcon.ts b/packages/docs/src/lib/resolveIcon.ts similarity index 100% rename from packages/qvac-docs/src/lib/resolveIcon.ts rename to packages/docs/src/lib/resolveIcon.ts diff --git a/packages/qvac-docs/src/lib/source.ts b/packages/docs/src/lib/source.ts similarity index 100% rename from packages/qvac-docs/src/lib/source.ts rename to packages/docs/src/lib/source.ts diff --git a/packages/qvac-docs/src/mdx-components.tsx b/packages/docs/src/mdx-components.tsx similarity index 100% rename from packages/qvac-docs/src/mdx-components.tsx rename to packages/docs/src/mdx-components.tsx diff --git a/packages/qvac-docs/tsconfig.json b/packages/docs/tsconfig.json similarity index 100% rename from packages/qvac-docs/tsconfig.json rename to packages/docs/tsconfig.json diff --git a/packages/qvac-sdk/test/mocks/changelog-tags.json b/packages/qvac-sdk/test/mocks/changelog-tags.json index 78859118dd..e55f50adff 100644 --- a/packages/qvac-sdk/test/mocks/changelog-tags.json +++ b/packages/qvac-sdk/test/mocks/changelog-tags.json @@ -6,16 +6,16 @@ "qvac-sdk-v1.1.0", "qvac-sdk-v1.2.0", "qvac-sdk-v2.0.0", - "qvac-docs-v1.0.0" + "docs-v1.0.0" ] }, "expected": { "latestForSdk": "qvac-sdk-v2.0.0", - "latestForDocs": "qvac-docs-v1.0.0", + "latestForDocs": "docs-v1.0.0", "versionFromTag": { "qvac-sdk-v2.0.0": "2.0.0", "qvac-sdk-v1.0.0": "1.0.0", - "qvac-docs-v1.0.0": "1.0.0" + "docs-v1.0.0": "1.0.0" } } }