Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/_layouts/latest-release-feature.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,5 +96,5 @@ <h5 class="modal-title mb-1" id="latestFeatureImageModalLabel">Latest Feature Pr
</article>

{% if feature_meta.images and feature_meta.images.size > 0 %}
<script src="{{ '/assets/js/latest-release.js' | relative_url }}"></script>
<script src="{{ '/assets/js/latest-release.js' | relative_url }}?v={{ site.time | date: '%s' }}"></script>
{% endif %}
122 changes: 122 additions & 0 deletions docs/_layouts/showcase-page.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
---
layout: default
---

{% assign accent = page.accent | default: 'blue' %}

<article class="page-content latest-release-page docs-showcase-page latest-release-accent--{{ accent }}">
<section class="latest-release-hero">
<div class="latest-release-hero-copy">
{% if page.breadcrumb and page.breadcrumb.url and page.breadcrumb.label %}
<div class="latest-release-breadcrumb">
Comment thread
paullizer marked this conversation as resolved.
<a href="{{ page.breadcrumb.url | relative_url }}"><i class="bi bi-arrow-left"></i> {{ page.breadcrumb.label }}</a>
</div>
{% endif %}

{% if page.eyebrow or page.hero_version %}
<div class="latest-release-pill-row">
{% if page.eyebrow %}
<span class="latest-release-pill">{{ page.eyebrow }}</span>
{% endif %}
{% if page.hero_version %}
<span class="latest-release-subtle">{{ page.hero_version }}</span>
{% endif %}
</div>
{% endif %}

<h1 class="latest-release-hero-title">{{ page.title }}</h1>

{% if page.description %}
<p class="latest-release-hero-description">{{ page.description }}</p>
{% endif %}

{% if page.hero_pills %}
<div class="latest-release-pill-row">
{% for pill in page.hero_pills %}
<span class="latest-release-pill">{{ pill }}</span>
{% endfor %}
</div>
{% endif %}

{% if page.hero_links %}
<div class="latest-release-hero-actions">
{% for link in page.hero_links %}
{% assign button_class = 'btn-outline-secondary' %}
{% if link.style == 'primary' %}
{% assign button_class = 'btn-primary' %}
{% elsif link.style == 'secondary' %}
{% assign button_class = 'btn-secondary' %}
{% endif %}
<a href="{{ link.url | relative_url }}" class="btn {{ button_class }} btn-sm">{{ link.label }}</a>
{% endfor %}
</div>
{% endif %}
</div>

<div class="latest-release-hero-art" aria-hidden="true">
{% if page.hero_icons and page.hero_icons.size > 1 %}
<div class="latest-release-hero-stack">
{% for icon in page.hero_icons limit: 3 %}
<span><i class="bi {{ icon }}"></i></span>
{% endfor %}
</div>
{% else %}
{% assign hero_icon = page.hero_icon %}
{% if hero_icon == nil and page.hero_icons and page.hero_icons.size > 0 %}
{% assign hero_icon = page.hero_icons[0] %}
{% endif %}
<div class="latest-release-icon-orb">
<i class="bi {{ hero_icon | default: 'bi-stars' }}"></i>
</div>
{% endif %}
</div>
</section>

<div class="latest-release-feature-content">
<div class="latest-release-rich-content">
{{ content }}
</div>

{% if page.show_nav and page.nav_links %}
<nav class="page-navigation mt-5">
<div class="row">
{% if page.nav_links.prev %}
<div class="col-md-6">
<a href="{{ page.nav_links.prev.url | relative_url }}" class="btn btn-outline-primary">
<i class="bi bi-arrow-left me-2"></i>{{ page.nav_links.prev.title }}
</a>
</div>
{% endif %}
{% if page.nav_links.next %}
<div class="col-md-6 text-end">
<a href="{{ page.nav_links.next.url | relative_url }}" class="btn btn-outline-primary">
{{ page.nav_links.next.title }}<i class="bi bi-arrow-right ms-2"></i>
</a>
</div>
{% endif %}
</div>
</nav>
{% endif %}
</div>

<div class="modal fade latest-feature-image-modal" id="latestFeatureImageModal" tabindex="-1" aria-labelledby="latestFeatureImageModalLabel" aria-hidden="true">
<div class="modal-dialog modal-dialog-centered modal-xl">
<div class="modal-content">
<div class="modal-header">
<div>
<h5 class="modal-title mb-1" id="latestFeatureImageModalLabel">Image Preview</h5>
<small class="latest-feature-image-modal-caption" id="latestFeatureImageModalCaption">Click outside the popup to close it.</small>
</div>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body pt-2">
<div class="latest-feature-image-frame">
<img id="latestFeatureImageModalImage" src="" alt="Image preview" />
</div>
</div>
</div>
</div>
</div>
</article>

<script src="{{ '/assets/js/latest-release.js' | relative_url }}?v={{ site.time | date: '%s' }}"></script>
99 changes: 89 additions & 10 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,97 @@
---
layout: page
title: About
layout: showcase-page
title: "About Simple Chat"
permalink: /about/
menubar: docs_menu
accent: teal
eyebrow: "Platform Overview"
description: "Simple Chat combines Azure-hosted chat, grounded retrieval, workspace management, and optional agent orchestration into one application surface."
hero_icons:
- bi-chat-square-text
- bi-database
- bi-diagram-3
hero_pills:
- Azure-native by design
- Workspace-first document grounding
- Optional agents and automation
hero_links:
- label: Start with setup
url: /setup_instructions/
style: primary
- label: Explore features
url: /features/
style: secondary
---

This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/)
Simple Chat is an enterprise-ready Flask application for teams that want conversational AI grounded in their own data, with admin controls that stay practical instead of sprawling.

You can find the source code for Minima at GitHub:
[jekyll][jekyll-organization] /
[minima](https://github.com/jekyll/minima)
<section class="latest-release-card-grid">
<article class="latest-release-card">
<div class="latest-release-card-icon"><i class="bi bi-chat-square-text"></i></div>
<h2>Grounded Chat</h2>
<p>Users can chat directly with models or switch into retrieval-backed conversations that cite files from personal, group, or public workspaces.</p>
</article>
<article class="latest-release-card">
<div class="latest-release-card-icon"><i class="bi bi-folder2-open"></i></div>
<h2>Document Workflows</h2>
<p>Uploads are processed through document extraction, chunking, embeddings, and search so teams can move from raw files to usable retrieval quickly.</p>
</article>
<article class="latest-release-card">
<div class="latest-release-card-icon"><i class="bi bi-sliders"></i></div>
<h2>Admin Control Surface</h2>
<p>Admins configure branding, models, workspaces, search, safety, logging, and scale features from one settings experience.</p>
</article>
</section>

You can find the source code for Jekyll at GitHub:
[jekyll][jekyll-organization] /
[jekyll](https://github.com/jekyll/jekyll)
<div class="latest-release-note-panel">
<h2>What the docs are optimized for</h2>
<p>The documentation is organized to help with three common paths: deploy the platform, configure the services behind it, and teach end users how to get value from workspaces, search, and agents.</p>
</div>

## Follow the right path

[jekyll-organization]: https://github.com/jekyll
<section class="latest-release-card-grid">
<article class="latest-release-card">
<div class="latest-release-card-icon"><i class="bi bi-rocket-takeoff"></i></div>
<h2>Deploy</h2>
<p>Use the guided deployment path if you want the fastest route into a working environment.</p>
<p><a href="{{ '/setup_instructions/' | relative_url }}">Open Getting Started</a></p>
</article>
<article class="latest-release-card">
<div class="latest-release-card-icon"><i class="bi bi-grid-1x2"></i></div>
<h2>Understand capabilities</h2>
<p>Review how chat, workspaces, safety, citations, multimedia, and agents fit together before expanding the deployment.</p>
<p><a href="{{ '/features/' | relative_url }}">Browse the feature map</a></p>
</article>
<article class="latest-release-card">
<div class="latest-release-card-icon"><i class="bi bi-gear"></i></div>
<h2>Operate and tune</h2>
<p>Use the admin, workflow, scaling, and troubleshooting guides when the platform moves from proof of concept into production support.</p>
<p><a href="{{ '/application_scaling/' | relative_url }}">Review scaling guidance</a></p>
</article>
<article class="latest-release-card">
<div class="latest-release-card-icon"><i class="bi bi-mortarboard"></i></div>
<h2>Teach the team</h2>
<p>The tutorial track is written for people who need to go from first login to useful document-grounded chat without reading every reference page first.</p>
<p><a href="{{ '/tutorials/' | relative_url }}">Open tutorials</a></p>
</article>
</section>

## Built as an open repo

The project lives in the open and includes application code, deployment assets, functional tests, UI tests, and deep change documentation under the docs tree.

<section class="latest-release-card-grid">
<article class="latest-release-card">
<div class="latest-release-card-icon"><i class="bi bi-github"></i></div>
<h2>Source and contribution flow</h2>
<p>Contributors can inspect the application, deployment scripts, docs site, and supporting tools in one repository.</p>
<p><a href="{{ '/contributing/' | relative_url }}">Read contribution guidance</a></p>
</article>
<article class="latest-release-card">
<div class="latest-release-card-icon"><i class="bi bi-journal-text"></i></div>
<h2>Release-by-release traceability</h2>
<p>Feature explanations, fixes, and release notes are captured inside the docs site so changes remain searchable after deployment work is done.</p>
<p><a href="{{ '/explanation/release_notes/' | relative_url }}">Review release notes</a></p>
</article>
</section>
63 changes: 56 additions & 7 deletions docs/admin_configuration.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,59 @@
# Simple Chat - Admin Configuration

[Return to Main](../README.md)

Once the application is running and you log in as a user assigned the Admin role, you can access the **Admin Settings** page. This UI provides a centralized location to configure most application features and service connections.

![alt text](./images/admin_settings_page.png)
---
layout: showcase-page
title: Admin Configuration
permalink: /admin_configuration/
menubar: docs_menu
accent: violet
eyebrow: Central Control Surface
description: Admin Settings turns a raw deployment into an operating environment by centralizing branding, model routing, workspace policy, safety controls, scale features, and logging.
hero_icons:
- bi-gear
- bi-sliders2-vertical
- bi-shield-check
hero_pills:
- Guided setup walkthrough included
- Model and workspace configuration in one UI
- Logging, safety, and scale controls available
hero_links:
- label: Getting started guide
url: /setup_instructions/
style: primary
- label: Manual setup reference
url: /setup_instructions_manual/
style: secondary
---

Once the application is running and you sign in with the Admin role, the Admin Settings page becomes the main place to configure the product without editing environment variables directly.

<section class="latest-release-card-grid">
<article class="latest-release-card">
<div class="latest-release-card-icon"><i class="bi bi-brush"></i></div>
<h2>General</h2>
<p>Brand the app, tune appearance, manage landing-page content, and control global behavior such as file limits and system prompts.</p>
</article>
<article class="latest-release-card">
<div class="latest-release-card-icon"><i class="bi bi-cpu"></i></div>
<h2>Models and retrieval</h2>
<p>Configure GPT, embeddings, image generation, Azure AI Search, Document Intelligence, and enhanced citations from the same settings surface.</p>
</article>
<article class="latest-release-card">
<div class="latest-release-card-icon"><i class="bi bi-people"></i></div>
<h2>Workspaces and agents</h2>
<p>Enable personal, group, and public workspaces, define classification behavior, and manage agent and action capabilities.</p>
</article>
<article class="latest-release-card">
<div class="latest-release-card-icon"><i class="bi bi-speedometer"></i></div>
<h2>Safety, scale, and logging</h2>
<p>Turn on Content Safety, Redis, Front Door, Application Insights logging, and other controls that matter once the deployment grows up.</p>
</article>
</section>

<div class="latest-release-note-panel">
<h2>Best starting point</h2>
<p>The Setup Walkthrough is the fastest way to move a fresh environment from partially configured to usable. It guides admins through the critical dependencies in the right order and skips steps that do not apply.</p>
</div>

![Admin Settings page](./images/admin_settings_page.png)

## Setup Walkthrough

Expand Down
Loading
Loading