Skip to content

RDoc-3634 Expose Guides in Documentation #2240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mateuszbartosik wants to merge 9 commits into
base: main
Choose a base branch
from
Open

RDoc-3634 Expose Guides in Documentation #2240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1bee3a1
RDoc-3634 Guides page - initial commit
Lwiel Jan 12, 2026
1df254d
RDoc-3634 Expose Guides
mateuszbartosik Jan 22, 2026
1ebf082
RDoc-3634 Remove buttonVariant and ctaLabel from mdx files
mateuszbartosik Jan 22, 2026
a2133e7
RDoc-3634 Add Custom Breadcrumbs
mateuszbartosik Jan 23, 2026
93eb954
RDOc-3634 Post-review fixes
mateuszbartosik Jan 27, 2026
be60845
RDoc-3634 Add external guides integration
mateuszbartosik Jan 27, 2026
ee44b63
RDoc-3634 Sidebar adjustments
mateuszbartosik Jan 28, 2026
e325dcb
RDOc-3634 Expose /templates using plugin-content-docs
mateuszbartosik Jan 28, 2026
8e53400
RDoc-3634 Import external guides
mateuszbartosik Jan 29, 2026
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
2 changes: 2 additions & 0 deletions cloud/home.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
slug: /
pagination_next: null
pagination_prev: null
wrapperClassName: cloud-home-page
hide_table_of_contents: true
---

import CloudUseCases from '@site/src/components/Homepage/UseCases/CloudUseCases';
Expand Down
10 changes: 5 additions & 5 deletions docs/ai-integration/ai-agents/start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,20 @@ Creating an AI agent and assigning it a role can be done in minutes using Studio
Use the technical documentation to learn how to create and manage AI agents, configure secure database access, enable agents to trigger client actions, and more.

<ColGrid colCount={2}>
<CardWithImage title="AI Agents Overview" description="Learn the basic concepts of RavenDB's native AI agents" url="../../ai-integration/ai-agents/overview" imgIcon="ai-agents" ctaLabel="Read" />
<CardWithImage title="Creating agents using Studio" description="Learn how to easily create and test AI agents using Studio" url="../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio" imgIcon="studio-config" ctaLabel="Read" />
<CardWithImage title="AI Agents Overview" description="Learn the basic concepts of RavenDB's native AI agents" url="../../ai-integration/ai-agents/overview" imgIcon="ai-agents" />
<CardWithImage title="Creating agents using Studio" description="Learn how to easily create and test AI agents using Studio" url="../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio" imgIcon="studio-config" />
</ColGrid>

#### Learn more: In-depth AI agents articles
<ColGrid colCount={2}>
<CardWithImage title="Practical look at AI agents with RavenDB" description="A step-by-step tutorial for building AI agents with RavenDB, by Gracjan Sadowicz" imgSrc={practicalLookAiAgentsImage} url="https://ravendb.net/articles/practical-look-at-ai-agents-with-ravendb" imgAlt="Practical look at AI agents with RavenDB" ctaLabel="Read" />
<CardWithImage title="Practical look at AI agents with RavenDB" description="A step-by-step tutorial for building AI agents with RavenDB, by Gracjan Sadowicz" imgSrc={practicalLookAiAgentsImage} url="https://ravendb.net/articles/practical-look-at-ai-agents-with-ravendb" imgAlt="Practical look at AI agents with RavenDB" />
</ColGrid>

### Related lives & Videos
Watch our webinars to see AI agents in action and learn practical implementation techniques.

<ColGrid colCount={1}>
<CardWithImageHorizontal title="How to run AI agents natively in your database" description="Watch a webinar about AI agents." url="https://www.youtube.com/watch?v=A17GSLGN-cQ" imgSrc={webinarThumbnailPlaceholder} imgAlt="How to run AI agents natively in your database" ctaLabel="Watch" />
<CardWithImageHorizontal title="Creating powerful and secure AI agents with RavenDB" description="Webinar with Oren Eini" url="https://www.youtube.com/watch?v=jzUxL9P17G4" imgSrc={webinarThumbnailPlaceholder} imgAlt="Creating powerful and secure AI agents with RavenDB" ctaLabel="Watch" />
<CardWithImageHorizontal title="How to run AI agents natively in your database" description="Watch a webinar about AI agents." url="https://www.youtube.com/watch?v=A17GSLGN-cQ" imgSrc={webinarThumbnailPlaceholder} imgAlt="How to run AI agents natively in your database" />
<CardWithImageHorizontal title="Creating powerful and secure AI agents with RavenDB" description="Webinar with Oren Eini" url="https://www.youtube.com/watch?v=jzUxL9P17G4" imgSrc={webinarThumbnailPlaceholder} imgAlt="Creating powerful and secure AI agents with RavenDB" />
</ColGrid>

12 changes: 6 additions & 6 deletions docs/ai-integration/gen-ai-integration/start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,19 @@ GenAI tasks can infuse intelligence into a wide variety of content handling scen
Learn how to create and manage tasks that intelligently process your data and transform your content.

<ColGrid colCount={2}>
<CardWithImage title="GenAI tasks overview" description="Learn the concepts and flow of GenAI tasks in RavenDB" url="../../ai-integration/gen-ai-integration/overview" imgIcon="genai" ctaLabel="Read" />
<CardWithImage title="Creating tasks using Studio" description="Learn to create and test GenAI tasks using Studio" url="../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio" imgIcon="studio-config" ctaLabel="Read" />
<CardWithImage title="GenAI tasks overview" description="Learn the concepts and flow of GenAI tasks in RavenDB" url="../../ai-integration/gen-ai-integration/overview" imgIcon="genai" />
<CardWithImage title="Creating tasks using Studio" description="Learn to create and test GenAI tasks using Studio" url="../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio" imgIcon="studio-config" />
</ColGrid>

#### Learn more: In-depth GenAI tasks articles
<ColGrid colCount={3}>
<CardWithImage title="RavenDB GenAI deep dive" description="A deep-dive with hands-on examples and implementation details, by Oren Eini" imgSrc={ayendeBlogImage} url="https://ravendb.net/articles/ravendb-genai-deep-dive" imgAlt="RavenDB GenAI Deep Dive" ctaLabel="Read" />
<CardWithImage title="Survive the AI tidal wave with RavenDB & GenAI" description="A real-world demo using GenAI for intelligent support ticket automation, by Paweł Lachowski" imgSrc={articleGenAiImage} url="https://ravendb.net/articles/survive-the-ai-tidal-wave-with-ravendb-genai" imgAlt="Survive the AI tidal wave with RavenDB & GenAI" ctaLabel="Read" />
<CardWithImage title="Unlock RavenDB GenAI potential with attachments" description="A practical guide to processing PDFs, images, and files with GenAI, by Paweł Lachowski" imgSrc={unlockGenAiPotentialArticleImage} url="https://ravendb.net/articles/unlock-ravendb-genai-potential-with-attachments" imgAlt="Unlock RavenDB GenAI potential with attachments" ctaLabel="Read" />
<CardWithImage title="RavenDB GenAI deep dive" description="A deep-dive with hands-on examples and implementation details, by Oren Eini" imgSrc={ayendeBlogImage} url="https://ravendb.net/articles/ravendb-genai-deep-dive" imgAlt="RavenDB GenAI Deep Dive" />
<CardWithImage title="Survive the AI tidal wave with RavenDB & GenAI" description="A real-world demo using GenAI for intelligent support ticket automation, by Paweł Lachowski" imgSrc={articleGenAiImage} url="https://ravendb.net/articles/survive-the-ai-tidal-wave-with-ravendb-genai" imgAlt="Survive the AI tidal wave with RavenDB & GenAI" />
<CardWithImage title="Unlock RavenDB GenAI potential with attachments" description="A practical guide to processing PDFs, images, and files with GenAI, by Paweł Lachowski" imgSrc={unlockGenAiPotentialArticleImage} url="https://ravendb.net/articles/unlock-ravendb-genai-potential-with-attachments" imgAlt="Unlock RavenDB GenAI potential with attachments" />
</ColGrid>

### Related lives & Videos
Learn how GenAI tasks help create reliable and effective AI-powered workflows.
<ColGrid colCount={1}>
<CardWithImageHorizontal title="Why are GenAI tasks so effective" description="Watch a webinar about GenAI tasks." url="https://www.youtube.com/watch?v=NgvyeHwwVjM" imgSrc={webinarThumbnailPlaceholder} imgAlt="Why are GenAI tasks so effective" ctaLabel="Watch" />
<CardWithImageHorizontal title="Why are GenAI tasks so effective" description="Watch a webinar about GenAI tasks." url="https://www.youtube.com/watch?v=NgvyeHwwVjM" imgSrc={webinarThumbnailPlaceholder} imgAlt="Why are GenAI tasks so effective" />
</ColGrid>
6 changes: 1 addition & 5 deletions docs/ai-integration/generating-embeddings/start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,12 @@ Common use cases include:
description="Step-by-step setup guide for AI-powered semantic search, by Paweł Lachowski"
imgSrc={aiSearchArticleImage} url="https://ravendb.net/articles/embeddings-generation-with-ravendb"
imgAlt="Embeddings with RavenDB and External Models"
ctaLabel="Read article"
/>
<CardWithImage
title="The integration of embeddings generation in RavenDB"
description="The reasoning and architecture behind RavenDB's embeddings feature, by Oren Eini"
imgSrc={ayendeBlogImage} url="https://ravendb.net/articles/ai-integration-in-ravendb-embeddings-generation"
imgAlt="The integration of embeddings generation in RavenDB"
ctaLabel="Read article"
/>
</ColGrid>

Expand All @@ -105,14 +103,12 @@ Learn more about enhancing your applications using vector search operations.
url="https://www.youtube.com/watch?v=7DhbgfH_rSE"
imgSrc={webinarThumbnailPlaceholder}
imgAlt="Taking over the world with AI and RavenDB"
ctaLabel="Watch"
/>
<CardWithImageHorizontal
title="Vector search in RavenDB"
description="The AI trend developers simply cannot ignore."
url="https://www.youtube.com/watch?v=zZwid8LA-e4"
imgSrc={discordLargeThumbnailPlaceholder}
imgAlt="Vector search in RavenDB"
ctaLabel="Watch"
/>
</ColGrid>
</ColGrid>
32 changes: 16 additions & 16 deletions docs/ai-integration/start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,56 +37,56 @@ RavenDB AI features help you ship any AI-related scenario quickly, including:

#### Learn more: In-depth AI features articles
<ColGrid colCount={2}>
<CardWithImage title="RavenDB GenAI deep dive" description="A deep-dive with hands-on examples and implementation details, by Oren Eini" imgSrc={ayendeBlogImage} url="https://ravendb.net/articles/ravendb-genai-deep-dive" imgAlt="RavenDB GenAI Deep Dive" ctaLabel="Read" />
<CardWithImage title="Practical look at AI agents with RavenDB" description="A step-by-step tutorial for building AI agents with RavenDB, by Gracjan Sadowicz" imgSrc={practicalLookAiAgentsImage} url="https://ravendb.net/articles/practical-look-at-ai-agents-with-ravendb" imgAlt="Practical look at AI agents with RavenDB" ctaLabel="Read" />
<CardWithImage title="RavenDB GenAI deep dive" description="A deep-dive with hands-on examples and implementation details, by Oren Eini" imgSrc={ayendeBlogImage} url="https://ravendb.net/articles/ravendb-genai-deep-dive" imgAlt="RavenDB GenAI Deep Dive" />
<CardWithImage title="Practical look at AI agents with RavenDB" description="A step-by-step tutorial for building AI agents with RavenDB, by Gracjan Sadowicz" imgSrc={practicalLookAiAgentsImage} url="https://ravendb.net/articles/practical-look-at-ai-agents-with-ravendb" imgAlt="Practical look at AI agents with RavenDB" />
</ColGrid>

### AI agents
AI agents are conversational proxy components that reside on the server and autonomously handle client requests using an AI model. Instead of spending your time on integrating AI capabilities into your application, you can rapidly configure AI agents using Studio or the client API. Agents can securely read from the database and request the client for actions on behalf of the AI model, infusing intelligence into the workflow. Whether you need chatbots, automated reporting, or intelligent data processing, you get immediate production-ready AI features without the integration overhead.

<ColGrid colCount={2}>
<CardWithImage title="AI agents start page" description="Continue to the AI agents Start page." url="../ai-integration/ai-agents/start" imgIcon="ai-agents" ctaLabel="Read" />
<CardWithImage title="Technical documentation" description="Learn how to create, deploy, manage conversations, and get results with AI agents." url="../ai-integration/ai-agents/start#technical-documentation" imgIcon="console" ctaLabel="Read" />
<CardWithImage title="AI agents start page" description="Continue to the AI agents Start page." url="../ai-integration/ai-agents/start" imgIcon="ai-agents" />
<CardWithImage title="Technical documentation" description="Learn how to create, deploy, manage conversations, and get results with AI agents." url="../ai-integration/ai-agents/start#technical-documentation" imgIcon="console" />
</ColGrid>

### GenAI tasks
GenAI tasks are configurable [ongoing operations](../studio/database/tasks/ongoing-tasks/general-info) that process your documents systematically in the background using an AI model. Instead of building custom AI integration pipelines yourself, you can easily create tasks that weave AI capabilities into your data flow. They can enrich documents with AI-generated content, validate and categorize data, translate documents, or execute countless other automated workflows that leverage AI capabilities.

<ColGrid colCount={2}>
<CardWithImage title="GenAI tasks start page" description="Continue to the GenAI tasks Start page." url="../ai-integration/gen-ai-integration/start" imgIcon="genai" ctaLabel="Read" />
<CardWithImage title="Technical documentation" description="Learn to create GenAI tasks that process your data and enable intelligent workflows automation." url="../ai-integration/gen-ai-integration/start#technical-documentation" imgIcon="console" ctaLabel="Read" />
<CardWithImage title="GenAI tasks start page" description="Continue to the GenAI tasks Start page." url="../ai-integration/gen-ai-integration/start" imgIcon="genai" />
<CardWithImage title="Technical documentation" description="Learn to create GenAI tasks that process your data and enable intelligent workflows automation." url="../ai-integration/gen-ai-integration/start#technical-documentation" imgIcon="console" />
</ColGrid>

### Embeddings generation
Embeddings generation tasks transform your content into semantic vectors that enable intelligent similarity-based searches. Instead of building complex search infrastructure, you can utilize native tasks that seamlessly embed vector capabilities into your data, enabling intelligent search by meaning and context.

<ColGrid colCount={2}>
<CardWithImage title="Embeddings generation Start page" description="Continue to the embeddings generation Start page." url="../ai-integration/generating-embeddings/start" imgIcon="embeddings" ctaLabel="Read" />
<CardWithImage title="Technical documentation" description="Learn to generate embeddings and enable intelligent searches." url="../ai-integration/generating-embeddings/start#technical-documentation" imgIcon="console" ctaLabel="Read" />
<CardWithImage title="Embeddings generation Start page" description="Continue to the embeddings generation Start page." url="../ai-integration/generating-embeddings/start" imgIcon="embeddings" />
<CardWithImage title="Technical documentation" description="Learn to generate embeddings and enable intelligent searches." url="../ai-integration/generating-embeddings/start#technical-documentation" imgIcon="console" />
</ColGrid>

### Vector search
Vector search enables intelligent similarity-based discovery using embeddings rather than exact matching. Instead of developing custom similarity algorithms yourself, you can employ native vector operations for diverse applications. Whether you need to categorize content, find similar items, or automate recommendations, vector search delivers intelligent matching capabilities that understand meaning and context.

<ColGrid colCount={2}>
<CardWithImage title="Vector search start page" description="Continue to the vector search Start page." url="../ai-integration/vector-search/start" imgIcon="vector-search" ctaLabel="Read" />
<CardWithImage title="Technical documentation" description="Learn to search your data by meaning and context." url="../ai-integration/vector-search/start#technical-documentation-links-" imgIcon="console" ctaLabel="Read" />
<CardWithImage title="Vector search start page" description="Continue to the vector search Start page." url="../ai-integration/vector-search/start" imgIcon="vector-search" />
<CardWithImage title="Technical documentation" description="Learn to search your data by meaning and context." url="../ai-integration/vector-search/start#technical-documentation-links-" imgIcon="console" />
</ColGrid>

### Related lives & Videos
Watch our broadcasts to see RavenDB's AI features in action and learn practical implementation techniques.

<ColGrid colCount={1}>
<CardWithImageHorizontal title="How to run AI agents natively in your database" description="Watch a webinar about AI agents." url="https://www.youtube.com/watch?v=A17GSLGN-cQ" imgSrc={webinarThumbnailPlaceholder} imgAlt="RavenDB Webinar" ctaLabel="Watch" />
<CardWithImageHorizontal title="Why are GenAI tasks so effective" description="Watch a webinar about GenAI tasks." url="https://www.youtube.com/watch?v=NgvyeHwwVjM" imgSrc={webinarThumbnailPlaceholder} imgAlt="RavenDB Webinar" ctaLabel="Watch" />
<CardWithImageHorizontal title="Taking over the world with AI and RavenDB" description="Watch a webinar about vector search." url="https://www.youtube.com/watch?v=7DhbgfH_rSE" imgSrc={webinarThumbnailPlaceholder} imgAlt="RavenDB Webinar" ctaLabel="Watch" />
<CardWithImageHorizontal title="How to run AI agents natively in your database" description="Watch a webinar about AI agents." url="https://www.youtube.com/watch?v=A17GSLGN-cQ" imgSrc={webinarThumbnailPlaceholder} imgAlt="RavenDB Webinar" />
<CardWithImageHorizontal title="Why are GenAI tasks so effective" description="Watch a webinar about GenAI tasks." url="https://www.youtube.com/watch?v=NgvyeHwwVjM" imgSrc={webinarThumbnailPlaceholder} imgAlt="RavenDB Webinar" />
<CardWithImageHorizontal title="Taking over the world with AI and RavenDB" description="Watch a webinar about vector search." url="https://www.youtube.com/watch?v=7DhbgfH_rSE" imgSrc={webinarThumbnailPlaceholder} imgAlt="RavenDB Webinar" />
</ColGrid>

### Deep dives, content & resources
Find additional resources to enhance your knowledge and skills.

<ColGrid colCount={3}>
<CardWithImage title="Build vs. Buy" description="The difference between building an AI agent infrastructure from scratch and using RavenDB's native AI agents" imgSrc={buildVsBuyStartImage} url="https://ravendb.net/articles/build-vs-buy-the-real-cost-of-adding-ai-agents-to-your-application" imgAlt="AI agents: Build vs. Buy" ctaLabel="Read" />
<CardWithImage title="Introduction to vector search" description="A glimpse of what can be achieved with vector search" url="https://ravendb.net/articles/new-in-7-0-ravendbs-vector-search" imgSrc={vectorSearchIntroImage} imgAlt="Introduction to vector search" ctaLabel="Read" />
<CardWithImage title="Future-proof your tech stack" description="Where Does GenAI Truly Fit" url="https://www.youtube.com/watch?v=OjEAWHGKyJY" imgSrc={discordThumbnailPlaceholder} imgAlt="Future-proof your tech stack" ctaLabel="Watch" />
<CardWithImage title="Build vs. Buy" description="The difference between building an AI agent infrastructure from scratch and using RavenDB's native AI agents" imgSrc={buildVsBuyStartImage} url="https://ravendb.net/articles/build-vs-buy-the-real-cost-of-adding-ai-agents-to-your-application" imgAlt="AI agents: Build vs. Buy" />
<CardWithImage title="Introduction to vector search" description="A glimpse of what can be achieved with vector search" url="https://ravendb.net/articles/new-in-7-0-ravendbs-vector-search" imgSrc={vectorSearchIntroImage} imgAlt="Introduction to vector search" />
<CardWithImage title="Future-proof your tech stack" description="Where Does GenAI Truly Fit" url="https://www.youtube.com/watch?v=OjEAWHGKyJY" imgSrc={discordThumbnailPlaceholder} imgAlt="Future-proof your tech stack" />
</ColGrid>
Loading