add canonical url headers

AngeloDanducci · AngeloDanducci · commit 126c494f757d · 2026-04-29T13:29:02.000-04:00
diff --git a/docs/docs/advanced/custom-components.md b/docs/docs/advanced/custom-components.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/advanced/custom-components"
 title: "Building Custom Components"
 description: "Implement the Component Protocol to create reusable, testable generative building blocks."
 # diataxis: how-to
diff --git a/docs/docs/advanced/inference-time-scaling.md b/docs/docs/advanced/inference-time-scaling.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/advanced/inference-time-scaling"
 title: "Inference-Time Scaling"
 description: "Control how Mellea generates and validates outputs: rejection sampling, SOFAI, budget forcing, and majority voting."
 # diataxis: how-to
diff --git a/docs/docs/advanced/intrinsics.md b/docs/docs/advanced/intrinsics.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/advanced/intrinsics"
 title: "Intrinsics"
 description: "Adapter-accelerated RAG quality checks using LoRA/aLoRA adapters with Granite models."
 # diataxis: how-to
diff --git a/docs/docs/advanced/lora-and-alora-adapters.md b/docs/docs/advanced/lora-and-alora-adapters.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/advanced/lora-and-alora-adapters"
 title: "LoRA and aLoRA adapters"
 description: "Train lightweight adapters on your own labeled data and use them as requirement validators in Mellea programs."
 # diataxis: how-to
diff --git a/docs/docs/advanced/mellea-core-internals.md b/docs/docs/advanced/mellea-core-internals.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/advanced/mellea-core-internals"
 title: "Mellea Core Internals"
 description: "The three core data structures and abstraction layers underlying every Mellea program."
 sidebarTitle: "Core Internals"
diff --git a/docs/docs/advanced/prefix-caching-and-kv-blocks.md b/docs/docs/advanced/prefix-caching-and-kv-blocks.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/advanced/prefix-caching-and-kv-blocks"
 title: "Prefix Caching and KV Blocks"
 description: "Reuse KV cache state across calls to eliminate redundant prefill work on LocalHFBackend."
 # diataxis: how-to
diff --git a/docs/docs/advanced/security-and-taint-tracking.md b/docs/docs/advanced/security-and-taint-tracking.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/advanced/security-and-taint-tracking"
 title: "Security and Taint Tracking"
 description: "Use GuardianCheck with IBM Granite Guardian to validate LLM outputs for safety risks."
 # diataxis: how-to
diff --git a/docs/docs/advanced/template-formatting.md b/docs/docs/advanced/template-formatting.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/advanced/template-formatting"
 title: "Template formatting"
 description: "How Mellea's TemplateFormatter converts Python objects into model-ready text using Jinja2 templates."
 # diataxis: explanation
diff --git a/docs/docs/community/building-extensions.md b/docs/docs/community/building-extensions.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/community/building-extensions"
 title: "Building Extensions"
 description: "Create custom components, backends, sampling strategies, and requirements to extend Mellea."
 # diataxis: how-to
diff --git a/docs/docs/community/code-of-conduct.md b/docs/docs/community/code-of-conduct.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/community/code-of-conduct"
 title: "Code of Conduct"
 description: "Standards and enforcement for the Mellea community."
 # diataxis: reference
diff --git a/docs/docs/community/contributing-guide.md b/docs/docs/community/contributing-guide.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/community/contributing-guide"
 title: "Contributing to Mellea"
 description: "Development setup, coding standards, and PR process for Mellea contributors."
 # diataxis: how-to
diff --git a/docs/docs/concepts/architecture-vs-agents.md b/docs/docs/concepts/architecture-vs-agents.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/concepts/architecture-vs-agents"
 title: "Mellea vs Orchestration Frameworks"
 description: "What makes Mellea different from LangChain, smolagents, and other agent frameworks — and how they work together."
 # diataxis: explanation
diff --git a/docs/docs/concepts/context-and-sessions.md b/docs/docs/concepts/context-and-sessions.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/concepts/context-and-sessions"
 title: "Context and Sessions"
 description: "How Component, Backend, Context, and Session fit together in Mellea's architecture."
 # diataxis: explanation
diff --git a/docs/docs/concepts/generative-functions.md b/docs/docs/concepts/generative-functions.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/concepts/generative-functions"
 title: "Generative Functions"
 description: "How the @generative decorator turns a Python function signature into an LLM-backed implementation."
 # diataxis: explanation
diff --git a/docs/docs/concepts/generative-programming.md b/docs/docs/concepts/generative-programming.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/concepts/generative-programming"
 title: "Generative Programming"
 description: "The ideas behind Mellea — what generative programs are, why they're hard, and how Mellea addresses those challenges."
 # diataxis: explanation
diff --git a/docs/docs/concepts/instruct-validate-repair.md b/docs/docs/concepts/instruct-validate-repair.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/concepts/instruct-validate-repair"
 title: "The Instruction Model"
 description: "How instruct(), requirements, and the IVR loop work in Mellea."
 # diataxis: explanation
diff --git a/docs/docs/concepts/mobjects-and-mify.md b/docs/docs/concepts/mobjects-and-mify.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/concepts/mobjects-and-mify"
 title: "MObjects and mify"
 description: "How the @mify decorator turns any Python class into an LLM-queryable object with controlled field and method exposure."
 # diataxis: explanation
diff --git a/docs/docs/concepts/requirements-system.md b/docs/docs/concepts/requirements-system.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/concepts/requirements-system"
 title: "The Requirements System"
 description: "How Requirement, ValidationResult, and the IVR loop work together to enforce constraints on generative output."
 # diataxis: explanation
diff --git a/docs/docs/examples/data-extraction-pipeline.md b/docs/docs/examples/data-extraction-pipeline.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/examples/data-extraction-pipeline"
 title: "Data Extraction Pipeline"
 description: "Use the @generative decorator with a typed return value to extract structured data from unstructured text in a single declarative function."
 # diataxis: reference
diff --git a/docs/docs/examples/index.md b/docs/docs/examples/index.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/examples/index"
 title: "Examples"
 description: "Complete working programs demonstrating Mellea patterns in production-like scenarios."
 # diataxis: reference
diff --git a/docs/docs/examples/legacy-code-integration.md b/docs/docs/examples/legacy-code-integration.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/examples/legacy-code-integration"
 title: "Legacy Code Integration with @mify"
 description: "Apply the @mify decorator to existing Python classes so a Mellea session can act on, query, and transform your objects without rewriting them."
 # diataxis: reference
diff --git a/docs/docs/examples/resilient-rag-fallback.md b/docs/docs/examples/resilient-rag-fallback.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/examples/resilient-rag-fallback"
 title: "Resilient RAG with Fallback Filtering"
 description: "Build a retrieval-augmented generation pipeline that uses FAISS for vector search and a @generative relevance filter to remove noise before generation."
 # diataxis: reference
diff --git a/docs/docs/examples/traced-generation-loop.md b/docs/docs/examples/traced-generation-loop.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/examples/traced-generation-loop"
 title: "Traced Generation Loop"
 description: "Enable OpenTelemetry tracing for a multi-operation Mellea session using environment variables, and export spans to Jaeger or any OTLP backend."
 # diataxis: reference
diff --git a/docs/docs/getting-started/installation.md b/docs/docs/getting-started/installation.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/getting-started/installation"
 title: "Installation"
 description: "Install Mellea and set up your Python environment."
 # diataxis: tutorial
diff --git a/docs/docs/getting-started/quickstart.md b/docs/docs/getting-started/quickstart.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/getting-started/quickstart"
 title: "Quick Start"
 description: "Run your first generative program in minutes."
 # diataxis: tutorial
diff --git a/docs/docs/how-to/act-and-aact.md b/docs/docs/how-to/act-and-aact.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/guide/act-and-aact"
 title: "act() and aact()"
 description: "Work directly with Components using act(), aact(), and the functional API."
 # diataxis: how-to
diff --git a/docs/docs/how-to/backends-and-configuration.md b/docs/docs/how-to/backends-and-configuration.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/guide/backends-and-configuration"
 title: "Backends and Configuration"
 description: "Configure Mellea to use Ollama, OpenAI, LiteLLM, HuggingFace, or WatsonX backends."
 # diataxis: how-to
diff --git a/docs/docs/how-to/build-a-rag-pipeline.md b/docs/docs/how-to/build-a-rag-pipeline.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/how-to/build-a-rag-pipeline"
 title: "Build a RAG Pipeline"
 description: "Combine vector retrieval with Mellea's generative filtering and grounded generation to build a reliable retrieval-augmented generation system."
 # diataxis: how-to
diff --git a/docs/docs/how-to/configure-model-options.md b/docs/docs/how-to/configure-model-options.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/how-to/configure-model-options"
 title: "Configure model options"
 description: "Set temperature, seed, max tokens, system prompts, and other backend parameters at session level or per call."
 # diataxis: how-to
diff --git a/docs/docs/how-to/enforce-structured-output.md b/docs/docs/how-to/enforce-structured-output.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/how-to/enforce-structured-output"
 title: "Enforce Structured Output"
 description: "Get JSON, Pydantic models, and typed values from LLM calls using @generative and instruct(format=...)."
 # diataxis: how-to
diff --git a/docs/docs/how-to/evaluate-with-llm-as-a-judge.md b/docs/docs/how-to/evaluate-with-llm-as-a-judge.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/evaluation-and-observability/evaluate-with-llm-as-a-judge"
 title: "Evaluate with LLM-as-a-Judge"
 description: "Use the LLM itself to evaluate output quality — inline as a requirement, or as a standalone validation pass."
 # diataxis: how-to
diff --git a/docs/docs/how-to/generative-functions.md b/docs/docs/how-to/generative-functions.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/guide/generative-functions"
 title: "Generative Functions"
 description: "Define type-safe LLM functions with @generative and Pydantic structured output."
 # diataxis: how-to
diff --git a/docs/docs/how-to/handling-exceptions.md b/docs/docs/how-to/handling-exceptions.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/how-to/handling-exceptions"
 title: "Handling Exceptions and Failures"
 description: "Handle SamplingResult failures, PreconditionException, and parse errors gracefully in Mellea programs."
 # diataxis: how-to
diff --git a/docs/docs/how-to/m-decompose.md b/docs/docs/how-to/m-decompose.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/guide/m-decompose"
 title: "m decompose"
 description: "Break complex tasks into ordered, executable subtasks with the m decompose CLI."
 # diataxis: how-to
diff --git a/docs/docs/how-to/refactor-prompts-with-cli.md b/docs/docs/how-to/refactor-prompts-with-cli.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/how-to/refactor-prompts-with-cli"
 title: "Refactor Prompts with the CLI"
 sidebarTitle: "Refactor with m decompose"
 description: "Use m decompose to break a complex prompt into typed, validated generative functions."
diff --git a/docs/docs/how-to/tools-and-agents.md b/docs/docs/how-to/tools-and-agents.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/guide/tools-and-agents"
 title: "Tools and Agents"
 description: "Give LLMs access to tools, build ReACT agents, and validate tool call arguments."
 # diataxis: how-to
diff --git a/docs/docs/how-to/unit-test-generative-code.md b/docs/docs/how-to/unit-test-generative-code.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/how-to/unit-test-generative-code"
 title: "Unit Test Generative Code"
 description: "Write reliable tests for @generative functions using pytest markers and output validation."
 # diataxis: how-to
diff --git a/docs/docs/how-to/use-async-and-streaming.md b/docs/docs/how-to/use-async-and-streaming.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/how-to/use-async-and-streaming"
 title: "Async and Streaming"
 description: "Use async methods, parallel generation, and streaming output with Mellea."
 # diataxis: how-to
diff --git a/docs/docs/how-to/use-context-and-sessions.md b/docs/docs/how-to/use-context-and-sessions.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/how-to/use-context-and-sessions"
 title: "Context and Sessions"
 sidebarTitle: "Extending Sessions"
 description: "Extend MelleaSession to add custom validation, logging, and filtering behavior."
diff --git a/docs/docs/how-to/use-images-and-vision.md b/docs/docs/how-to/use-images-and-vision.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/how-to/use-images-and-vision"
 title: "Use Images and Vision Models"
 description: "Pass images to instruct() and chat() calls, and configure vision-capable backends."
 # diataxis: how-to
diff --git a/docs/docs/how-to/working-with-data.md b/docs/docs/how-to/working-with-data.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/guide/working-with-data"
 title: "Working with Data"
 description: "Ground instructions with documents, build RAG pipelines, and use MObjects and RichDocument."
 # diataxis: how-to
diff --git a/docs/docs/how-to/write-custom-verifiers.md b/docs/docs/how-to/write-custom-verifiers.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/how-to/write-custom-verifiers"
 title: "Write Custom Verifiers"
 description: "Write validation functions that inspect LLM output and return pass/fail results with repair guidance."
 # diataxis: how-to
diff --git a/docs/docs/integrations/bedrock.md b/docs/docs/integrations/bedrock.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/integrations/bedrock"
 title: "AWS Bedrock"
 description: "Run Mellea with AWS Bedrock models using the Bedrock Mantle backend or LiteLLM."
 # diataxis: how-to
diff --git a/docs/docs/integrations/huggingface.md b/docs/docs/integrations/huggingface.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/integrations/huggingface"
 title: "HuggingFace Transformers"
 description: "Run Mellea on local hardware with LocalHFBackend and HuggingFace Transformers."
 # diataxis: how-to
diff --git a/docs/docs/integrations/langchain.md b/docs/docs/integrations/langchain.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/integrations/langchain"
 title: "LangChain"
 description: "Use LangChain tools inside Mellea and seed a Mellea session with LangChain message history."
 # diataxis: how-to
diff --git a/docs/docs/integrations/m-serve.md b/docs/docs/integrations/m-serve.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/integrations/m-serve"
 title: "m serve"
 description: "Run a Mellea program as an OpenAI-compatible chat endpoint with m serve."
 # diataxis: how-to
diff --git a/docs/docs/integrations/mcp.md b/docs/docs/integrations/mcp.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/integrations/mcp"
 title: "MCP Integration"
 description: "Expose Mellea functions as Model Context Protocol tools, callable from Claude Desktop, Cursor, and any MCP-compatible client."
 # diataxis: how-to
diff --git a/docs/docs/integrations/ollama.md b/docs/docs/integrations/ollama.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/integrations/ollama"
 title: "Ollama"
 description: "Run Mellea with local models via Ollama — the default backend."
 # diataxis: how-to
diff --git a/docs/docs/integrations/openai.md b/docs/docs/integrations/openai.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/integrations/openai"
 title: "OpenAI and OpenAI-Compatible APIs"
 description: "Use Mellea with OpenAI's API and any OpenAI-compatible endpoint — LM Studio, vLLM, Anthropic, and more."
 # diataxis: how-to
diff --git a/docs/docs/integrations/smolagents.md b/docs/docs/integrations/smolagents.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/integrations/smolagents"
 title: "smolagents"
 description: "Use HuggingFace smolagents tools inside a Mellea session."
 # diataxis: how-to
diff --git a/docs/docs/integrations/vertex-ai.md b/docs/docs/integrations/vertex-ai.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/integrations/vertex-ai"
 title: "Vertex AI"
 description: "Connect Mellea to Google Vertex AI models via LiteLLM."
 # diataxis: how-to
diff --git a/docs/docs/integrations/watsonx.md b/docs/docs/integrations/watsonx.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/integrations/watsonx"
 title: "IBM WatsonX"
 description: "Run Mellea with IBM WatsonX AI using the WatsonxAIBackend."
 # diataxis: how-to
diff --git a/docs/docs/observability/logging.md b/docs/docs/observability/logging.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/evaluation-and-observability/logging"
 title: "Logging"
 description: "Configure Mellea's console logging and export logs to OTLP collectors."
 # diataxis: how-to
diff --git a/docs/docs/observability/metrics.md b/docs/docs/observability/metrics.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/evaluation-and-observability/metrics"
 title: "Metrics"
 description: "Automatically collect LLM metrics and instrument your own code with OpenTelemetry counters, histograms, and up-down counters."
 # diataxis: how-to
diff --git a/docs/docs/observability/telemetry.md b/docs/docs/observability/telemetry.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/evaluation-and-observability/telemetry"
 title: "Telemetry"
 description: "Add OpenTelemetry tracing, metrics, and logging to Mellea programs."
 # diataxis: how-to
diff --git a/docs/docs/observability/tracing.md b/docs/docs/observability/tracing.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/evaluation-and-observability/tracing"
 title: "Tracing"
 description: "Export distributed traces from Mellea using OpenTelemetry semantic conventions."
 # diataxis: how-to
diff --git a/docs/docs/reference/glossary.md b/docs/docs/reference/glossary.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/guide/glossary"
 title: "Glossary"
 description: "Definitions of Mellea-specific terms and concepts."
 # diataxis: reference
diff --git a/docs/docs/troubleshooting/common-errors.md b/docs/docs/troubleshooting/common-errors.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/troubleshooting/common-errors"
 title: "Common Errors"
 description: "Common errors, diagnostic steps, and fixes for Mellea programs."
 # diataxis: reference
diff --git a/docs/docs/troubleshooting/faq.md b/docs/docs/troubleshooting/faq.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/troubleshooting/faq"
 title: "FAQ"
 description: "Answers to frequently asked questions about Mellea installation, backends, and generative functions."
 # diataxis: reference
diff --git a/docs/docs/tutorials/01-your-first-generative-program.md b/docs/docs/tutorials/01-your-first-generative-program.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/tutorials/01-your-first-generative-program"
 title: "Tutorial: Your First Generative Program"
 description: "Build a document analysis pipeline step by step — from a single instruct() call to a composed, typed, validated generative program."
 # diataxis: tutorial
diff --git a/docs/docs/tutorials/02-streaming-and-async.md b/docs/docs/tutorials/02-streaming-and-async.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/tutorials/02-streaming-and-async"
 title: "Tutorial: Streaming and Async"
 description: "Make LLM calls non-blocking, stream tokens as they arrive, and process batches concurrently."
 # diataxis: tutorial
diff --git a/docs/docs/tutorials/03-using-generative-stubs.md b/docs/docs/tutorials/03-using-generative-stubs.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/tutorials/03-using-generative-slots"
 title: "Tutorial: Using Generative Stubs"
 description: "Replace ad-hoc instruct() calls with typed, composable @generative functions."
 # diataxis: tutorial
diff --git a/docs/docs/tutorials/04-making-agents-reliable.md b/docs/docs/tutorials/04-making-agents-reliable.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/tutorials/04-making-agents-reliable"
 title: "Tutorial: Making Agents Reliable"
 description: "Add requirements validation and Guardian safety checks to a ReACT tool-using agent."
 # diataxis: tutorial
diff --git a/docs/docs/tutorials/05-mifying-legacy-code.md b/docs/docs/tutorials/05-mifying-legacy-code.md
@@ -1,4 +1,5 @@
 ---
+canonical: "https://docs.mellea.ai/tutorials/05-mifying-legacy-code"
 title: "Tutorial: Mifying Legacy Code"
 description: "Add LLM query and transform capabilities to existing Python classes without rewriting them."
 # diataxis: tutorial
