mptyl/ThothII
1
0
Fork 0
Code Issues 25 Pull Requests Actions Packages Projects Releases 1 Wiki Activity
Files
pages
ThothII/index.html
T

295 lines
11 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Understand, install, and use ThothII">
<link rel="canonical" href="https://git.tylconsulting.it/thothii-docs/">
<link rel="shortcut icon" href="./img/favicon.ico">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" />
<title>ThothII Docs</title>
<link href="./css/bootstrap-3.3.7.min.css" rel="stylesheet">
<link href="./css/font-awesome-4.7.0.css" rel="stylesheet">
<link href="./css/base.css" rel="stylesheet">
<link rel="stylesheet" href="./css/highlight.css">
<link href="stylesheets/extra.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
<script src="./js/jquery-3.2.1.min.js"></script>
<script src="./js/bootstrap-3.3.7.min.js"></script>
<script src="./js/highlight.pack.js"></script>
<script src="./js/elasticlunr.min.js"></script>
<base target="_top">
<script>
var base_url = '.';
var is_top_frame = (window === window.parent);
var pageToc = [
{title: "ThothII documentation", url: "#_top", children: [
{title: "Scope of this manual", url: "#scope-of-this-manual" },
]},
];
</script>
<script src="./js/base.js"></script>
<script src="javascripts/layout-init.js"></script>
</head>
<body>
<script>
if (is_top_frame) { $('body').addClass('wm-top-page'); }
</script>
<nav class="navbar wm-page-top-frame">
<div class="container-fluid wm-top-container">
<div class="wm-top-tool pull-right wm-vcenter">
<form class="dropdown wm-vcentered" id="wm-search-form" action="./search.html">
<button id="wm-search-show" class="btn btn-sm btn-default" type="submit"
><i class="fa fa-search" aria-hidden="true"></i></button>
<div class="input-group input-group-sm wm-top-search">
<input type="text" name="q" class="form-control" id="mkdocs-search-query" placeholder="Search" autocomplete="off">
<span class="input-group-btn" role="search">
<button class="btn btn-default dropdown-toggle collapse" data-toggle="dropdown" type="button"><span class="caret"></span></button>
<ul id="mkdocs-search-results" class="dropdown-menu dropdown-menu-right"></ul>
<button id="wm-search-go" class="btn btn-default" type="submit"><i class="fa fa-search" aria-hidden="true"></i></button>
</span>
</div>
</form>
</div>
<div class="wm-top-tool wm-vcenter pull-right wm-small-left">
<button id="wm-toc-button" type="button" class="btn btn-sm btn-default wm-vcentered"><i class="fa fa-th-list" aria-hidden="true"></i></button>
</div>
<a href="" class="wm-top-brand wm-top-link wm-vcenter">
<div class="wm-top-title">
ThothII Docs<br>
</div>
</a>
</div>
</nav>
<div id="main-content" class="wm-page-top-frame">
<nav class="wm-toc-pane">
<ul class="wm-toctree">
<li class="wm-toc-li wm-toc-lev1 "><a href="" class="wm-article-link wm-toc-text">Home</a>
</li>
<li class="wm-toc-li wm-toc-lev1 wm-toc-opener"><span class="wm-toc-text">Understand ThothII</span>
</li>
<li class="wm-toc-li-nested collapse">
<ul class="wm-toctree">
<li class="wm-toc-li wm-toc-lev2 "><a href="product-overview/" class="wm-article-link wm-toc-text">Product overview</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="skills/" class="wm-article-link wm-toc-text">Reviewed workflow</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="guida-utente/" class="wm-article-link wm-toc-text">User guide</a>
</li>
</ul>
</li>
<li class="wm-toc-li wm-toc-lev1 wm-toc-opener"><span class="wm-toc-text">Install</span>
</li>
<li class="wm-toc-li-nested collapse">
<ul class="wm-toctree">
<li class="wm-toc-li wm-toc-lev2 "><a href="install/first-start/" class="wm-article-link wm-toc-text">Start here</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="install/standalone-manual-it/" class="wm-article-link wm-toc-text">Mac, Windows, Linux — Italiano</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="install/standalone-manual-en/" class="wm-article-link wm-toc-text">Mac, Windows, Linux — English</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="install/shell-and-language/" class="wm-article-link wm-toc-text">Display mode and language</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="install/authentication-local/" class="wm-article-link wm-toc-text">Local authentication</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="install/authentication-oidc/" class="wm-article-link wm-toc-text">OIDC authentication</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="install/authentik/" class="wm-article-link wm-toc-text">Authentik</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="general/pi-configuration/" class="wm-article-link wm-toc-text">Model configuration</a>
</li>
</ul>
</li>
<li class="wm-toc-li wm-toc-lev1 wm-toc-opener"><span class="wm-toc-text">Administer</span>
</li>
<li class="wm-toc-li-nested collapse">
<ul class="wm-toctree">
<li class="wm-toc-li wm-toc-lev2 "><a href="operations/workspaces/" class="wm-article-link wm-toc-text">Workspaces</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="operations/database-management/" class="wm-article-link wm-toc-text">Databases and descriptions</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="operations/sensitivity-analysis/" class="wm-article-link wm-toc-text">Sensitive columns</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="evidence/" class="wm-article-link wm-toc-text">Evidence</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="usage/memory/" class="wm-article-link wm-toc-text">Memory</a>
</li>
</ul>
</li>
<li class="wm-toc-li wm-toc-lev1 wm-toc-opener"><span class="wm-toc-text">Connect a REST DWH</span>
</li>
<li class="wm-toc-li-nested collapse">
<ul class="wm-toctree">
<li class="wm-toc-li wm-toc-lev2 "><a href="install/dwh-auth-server/" class="wm-article-link wm-toc-text">Server</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="install/dwh-auth-client-enrollment/" class="wm-article-link wm-toc-text">Client enrollment</a>
</li>
<li class="wm-toc-li wm-toc-lev2 "><a href="install/dwh-auth-tls/" class="wm-article-link wm-toc-text">TLS</a>
</li>
</ul>
</li>
</ul>
</nav>
<div class="wm-content-pane">
<iframe class="wm-article" name="article"></iframe>
</div>
</div>
<div class="container-fluid wm-page-content">
<a name="_top"></a>
<div class="row wm-article-nav-buttons" role="navigation" aria-label="navigation">
<div class="wm-article-nav pull-right">
<a href="product-overview/" class="btn btn-xs btn-default pull-right">
Next
<i class="fa fa-chevron-right" aria-hidden="true"></i>
</a>
<a href="product-overview/" class="btn btn-xs btn-link">
Product overview
</a>
</div>
</div>
<h1 id="thothii-documentation">ThothII documentation<a class="headerlink" href="#thothii-documentation" title="Permanent link">&para;</a></h1>
<p>ThothII turns a natural-language question into reviewed SQL. The model proposes;
a human reviewer decides which interpretations, sources and results to accept.</p>
<p>This is the public product manual. Start with the task you need to perform:</p>
<table>
<thead>
<tr>
<th>I need to…</th>
<th>Start here</th>
</tr>
</thead>
<tbody>
<tr>
<td>Understand the product and its boundaries</td>
<td><a href="product-overview/">What ThothII does</a></td>
</tr>
<tr>
<td>Install on Mac, Windows through WSL2, or Linux</td>
<td><a href="install/standalone-manual-it/">Italian procedure</a> · <a href="install/standalone-manual-en/">English procedure</a></td>
</tr>
<tr>
<td>Choose display mode and language</td>
<td><a href="install/shell-and-language/">Display mode and language</a></td>
</tr>
<tr>
<td>Configure login</td>
<td><a href="install/authentication-local/">Local accounts</a> · <a href="install/authentication-oidc/">OIDC</a></td>
</tr>
<tr>
<td>Configure model providers</td>
<td><a href="general/pi-configuration/">Model configuration</a></td>
</tr>
<tr>
<td>Prepare a domain workspace</td>
<td><a href="operations/workspaces/">Workspaces</a></td>
</tr>
<tr>
<td>Configure databases and reviewed descriptions</td>
<td><a href="operations/database-management/">Database management</a></td>
</tr>
<tr>
<td>Ask a question and review SQL</td>
<td><a href="guida-utente/">User guide</a> · <a href="skills/">Workflow</a></td>
</tr>
<tr>
<td>Maintain domain knowledge</td>
<td><a href="evidence/">Evidence</a> · <a href="usage/memory/">Memory</a></td>
</tr>
</tbody>
</table>
<h2 id="scope-of-this-manual">Scope of this manual<a class="headerlink" href="#scope-of-this-manual" title="Permanent link">&para;</a></h2>
<p>The manual covers the product, installation, use and administration. Architecture,
code contracts, design decisions, implementation plans, test reports and site-specific
deployment handoffs are developer/project material maintained in the repository;
they are not pages of this site and are not included in its search index.</p>
<p>The installation procedures distinguish checked documentation from platform and
functional tests that still require execution. A clone does not transfer another
installation's credentials, data or network access.</p>
<p>The host-side <code>tht</code> command operates an installation. The Python workflow CLI inside
the runtime is a separate internal interface; do not substitute its commands for
the host installation procedure.</p>
<br>
<div class="row wm-article-nav-buttons" role="navigation" aria-label="navigation">
<div class="wm-article-nav pull-right">
<a href="product-overview/" class="btn btn-xs btn-default pull-right">
Next
<i class="fa fa-chevron-right" aria-hidden="true"></i>
</a>
<a href="product-overview/" class="btn btn-xs btn-link">
Product overview
</a>
</div>
</div>
<br>
</div>
<footer class="container-fluid wm-page-content">
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a> using <a href="https://github.com/gristlabs/mkdocs-windmill">Windmill</a> theme by Grist Labs.</p>
</footer>
</body>
</html>
<!--
MkDocs version : 1.6.1
Build Date UTC : 2026-09-26 22:42:07.304139+00:00
-->
Reference in New Issue View Git Blame Copy Permalink