Skip to content

Commit 04ec564

Browse files
committed
Reorganize Sophia documentation into separate menu section
1 parent e94e66f commit 04ec564

8 files changed

Lines changed: 45 additions & 38 deletions

File tree

_includes/docs-sidebar.html

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -169,17 +169,23 @@ <h3 class="mt-2">RESTHeart Cloud</h3>
169169
<li><a href="/docs/cloud/graphql">GraphQL Applications</a></li>
170170
<li><a href="/docs/cloud/webhooks">Webhooks</a></li>
171171

172-
<li class="subsection fw-bold mt-2">Sophia AI</li>
172+
<li class="subsection fw-bold mt-2">Examples</li>
173+
<li><a href="/docs/cloud/full-stack-example">Full-Stack Example</a></li>
174+
<li><a href="/docs/cloud/examples">Examples</a></li>
175+
</ul>
176+
</div>
177+
178+
<div class="part">
179+
<a data-bs-toggle="collapse" href="#part-sophia" role="button">
180+
<h3 class="mt-2">Sophia AI</h3>
181+
</a>
182+
<ul id="part-sophia" class="collapse">
173183
<li><a href="/docs/cloud/sophia/">Overview</a></li>
174184
<li><a href="/docs/cloud/sophia/setup">Setup</a></li>
175185
<li><a href="/docs/cloud/sophia/user-guide">User Guide</a></li>
176186
<li><a href="/docs/cloud/sophia/administrator-guide">Admin Guide</a></li>
177187
<li><a href="/docs/cloud/sophia/api-documentation">API Docs</a></li>
178188
<li><a href="/docs/cloud/sophia/mcp">MCP Server</a></li>
179-
180-
<li class="subsection fw-bold mt-2">Examples</li>
181-
<li><a href="/docs/cloud/full-stack-example">Full-Stack Example</a></li>
182-
<li><a href="/docs/cloud/examples">Examples</a></li>
183189
</ul>
184190
</div>
185191

@@ -233,6 +239,7 @@ <h3 class="mt-2">Reference</h3>
233239
'setup': 'part5', // Deployment
234240
'framework': 'part6', // Framework
235241
'cloud': 'part7', // RESTHeart Cloud
242+
'sophia': 'part-sophia', // Sophia AI
236243
'reference': 'part8' // Reference
237244
};
238245

docs/cloud/sophia/administrator-guide.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
docs_version: 9
33
title: Sophia AI - Administrator Guide
44
layout: docs-adoc
5-
menu: cloud
5+
menu: sophia
66
applies_to: cloud
77
---
88

docs/cloud/sophia/api-documentation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
docs_version: 9
33
title: Sophia AI - API Documentation
44
layout: docs-adoc
5-
menu: cloud
5+
menu: sophia
66
applies_to: cloud
77
---
88

docs/cloud/sophia/index.adoc

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,64 +2,64 @@
22
docs_version: 9
33
title: Sophia AI
44
layout: docs-adoc
5-
menu: cloud
6-
applies_to: cloud
5+
menu: sophia
6+
applies_to: both
77
---
88

9-
=== Intelligent AI Support for Your Organization
9+
=== Intelligent AI Powered by Your Knowledge
1010

11-
Sophia is an advanced AI service exclusively available with *RESTHeart Cloud*. Built by SoftInstigate, Sophia transforms your organization's knowledge base into an intelligent, conversational assistant that provides instant, accurate responses to your users' questions.
11+
Sophia is an AI assistant built by SoftInstigate that turns any knowledge base into an intelligent, conversational interface. It combines Claude (Anthropic's advanced language model) with Retrieval-Augmented Generation (RAG) to provide instant, accurate answers grounded in your documents.
1212

1313
image::../../../images/sophia/chat-interface.png[Sophia chat interface]
1414

15-
=== What is Sophia?
15+
=== Sophia for RESTHeart
1616

17-
Sophia leverages Large Language Models with Retrieval-Augmented Generation (RAG) technology to create an intelligent support system for organizations. Instead of users searching through documentation or waiting for human assistance, they can ask questions in natural language and receive immediate, contextual answers drawn from your organization's knowledge base.
17+
If you're here to learn about RESTHeart or RESTHeart Cloud, Sophia is already working for you. The link:/docs/sophia[AI Help] in the top navigation connects you to a Sophia instance trained on the full RESTHeart documentation — including plugin API, configuration guides, and source code examples. You can also connect it to Claude Desktop, Cursor, or VS Code via MCP (see link:/docs/cloud/sophia/mcp[MCP Server]).
1818

19-
The service combines Claude (Anthropic's advanced language model) with sophisticated document processing to understand both the intent behind questions and the content of your documents. When someone asks a question, Sophia searches through your uploaded materials using semantic understanding — not just keyword matching — to find the most relevant information, then crafts a conversational response that directly addresses the query.
19+
=== Sophia for Your Organization
2020

21-
=== Knowledge Base Management
21+
Sophia is available as a managed service through *RESTHeart Cloud* in the *dedicated* tier. You get your own Sophia instance, powered by your own knowledge base — with full control over contexts, documents, access, and AI behaviour through the admin panel.
2222

23-
Upload documents in multiple formats including PDFs, text files, HTML, and Markdown. Sophia automatically processes these materials, breaking them into searchable segments and creating vector embeddings that enable intelligent content discovery. The web-based admin panel provides intuitive tools for uploading, browsing, and managing your knowledge base.
23+
Upload your documents, configure your contexts, and your users get an intelligent assistant that understands your content. Customer support teams, educational institutions, and enterprise organizations use Sophia to make their knowledge instantly accessible.
2424

25-
image::../../../images/sophia/knowledge-list.png[Knowledge base management]
25+
image::../../../images/sophia/admin-panel.png[Admin panel]
2626

27-
=== Contexts and Knowledge Segregation
27+
=== Key Features
2828

29-
Organize your knowledge into isolated *contexts*, each with its own prompt template, document tags, and RAG configuration. Contexts ensure strict data separation — users in one context can never access documents from another. This makes it easy to serve different audiences (customers, internal staff, partners) from a single Sophia instance.
29+
==== Knowledge Base Management
3030

31-
image::../../../images/sophia/context-list.png[Context management]
31+
Upload documents in multiple formats (PDF, Markdown, HTML, plain text). Sophia automatically processes them into searchable segments with vector embeddings. The admin panel provides intuitive tools for uploading, browsing, and managing your knowledge base.
3232

33-
=== Agentic Mode
33+
image::../../../images/sophia/knowledge-list.png[Knowledge base management]
3434

35-
For complex questions that require gathering information from multiple sources, Sophia can operate as an autonomous agent. When agentic mode is enabled on a context, Sophia iteratively searches the knowledge base, reads files, and reasons about the results before composing a comprehensive response. Users see the agent's reasoning process in real time through tool execution badges.
35+
==== Contexts and Knowledge Segregation
3636

37-
image::../../../images/sophia/agentic-response.png[Agentic response]
37+
Organize your knowledge into isolated *contexts*, each with its own prompt template, document tags, and RAG configuration. Contexts ensure strict data separation — users in one context can never access documents from another. Serve different audiences (customers, internal staff, partners) from a single Sophia instance.
3838

39-
=== Admin Panel
39+
image::../../../images/sophia/context-list.png[Context management]
4040

41-
A full-featured web administration interface lets administrators manage the entire Sophia instance from the browser: create and configure contexts, upload and organize documents, inspect text segments, test semantic search quality, and issue scoped API tokens for programmatic access.
41+
==== Agentic Mode
4242

43-
image::../../../images/sophia/admin-panel.png[Admin panel]
43+
For complex questions, Sophia can operate as an autonomous agent. When agentic mode is enabled, Sophia iteratively searches the knowledge base, reads files, and reasons about the results before composing a comprehensive answer. Users see the reasoning process in real time.
4444

45-
=== Security and Access Control
45+
image::../../../images/sophia/agentic-response.png[Agentic response]
4646

47-
Cookie-based authentication secures the web interface, while JWT tokens provide programmatic access for APIs and MCP clients. Role-based permissions separate admin and user capabilities. API tokens can be scoped to specific contexts and tags, ensuring knowledge segregation extends to every access path.
47+
==== Security and Access Control
4848

49-
image::../../../images/sophia/token-list.png[API tokens]
49+
Cookie-based authentication secures the web interface, while JWT tokens provide programmatic access for APIs and MCP clients. API tokens can be scoped to specific contexts and tags, ensuring knowledge segregation extends to every access path.
5050

51-
=== MCP Server Integration
51+
==== MCP Server
5252

53-
Sophia exposes a *Model Context Protocol (MCP) server*, allowing AI clients and agents such as Claude Desktop, Cursor, and VS Code to connect directly to your knowledge base. The admin panel generates ready-to-paste MCP configuration snippets for each API token.
53+
Sophia exposes a *Model Context Protocol (MCP) server*, allowing AI clients such as Claude Desktop, Cursor, and VS Code to connect directly to your knowledge base. The admin panel generates ready-to-paste configuration snippets.
5454

5555
image::../../../images/sophia/token-mcp-config.png[MCP configuration]
5656

5757
See link:/docs/cloud/sophia/mcp[Sophia MCP Server] for setup instructions.
5858

59-
=== Flexible Integration
59+
==== Flexible Integration
6060

61-
The responsive chat interface works seamlessly across devices and can be embedded into existing websites via iframe or used standalone. Multi-language support (English/Italian) and customizable themes allow Sophia to match your organization's brand and user needs.
61+
The responsive chat interface works across devices and can be embedded into existing websites via iframe. Multi-language support (English/Italian) and customizable themes let Sophia match your brand.
6262

6363
=== Getting Started
6464

65-
Sophia is exclusively available through RESTHeart Cloud in the dedicated tier. See the link:/docs/cloud/sophia/setup[Setup Guide] to get started.
65+
See the link:/docs/cloud/sophia/setup[Setup Guide] to get your own Sophia instance.

docs/cloud/sophia/mcp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
docs_version: 9
33
title: Sophia MCP Server
44
layout: docs-adoc
5-
menu: cloud
5+
menu: sophia
66
applies_to: both
77
---
88

docs/cloud/sophia/setup.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
docs_version: 9
33
title: Sophia AI - Setup
44
layout: docs-adoc
5-
menu: cloud
5+
menu: sophia
66
applies_to: cloud
77
---
88

docs/cloud/sophia/system-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
docs_version: 9
33
title: Sophia AI - System Overview & Architecture
44
layout: docs-adoc
5-
menu: cloud
5+
menu: sophia
66
applies_to: cloud
77
---
88

docs/cloud/sophia/user-guide.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
docs_version: 9
33
title: Sophia AI - User Guide
44
layout: docs-adoc
5-
menu: cloud
5+
menu: sophia
66
applies_to: cloud
77
---
88

0 commit comments

Comments
 (0)