docs: update GitHub Pages

qe-collaborative-services · Jan 7, 2024 · 25d6dcf · 25d6dcf
1 parent 4575760
commit 25d6dcf
Show file tree

Hide file tree

Showing 4 changed files with 85 additions and 19 deletions.
diff --git a/support/docs/lib/ahc-hrsn-elt/screening/all_symbols.html b/support/docs/lib/ahc-hrsn-elt/screening/all_symbols.html
@@ -72,13 +72,10 @@ <h2 class="section_title" id="Class"><a href="#Class" aria-label="Anchor">Classe
         </td>
         <td class="symbol_section_doc">
         <div class="markdown_summary"><p>Encapsulates <a href="https://sql.ophir.dev/">SQLPage</a> content. SqlPageNotebook has
-methods with the name of each <a href="https://sql.ophir.dev/">SQLPage</a> content that
-we want in the database. The MutationSqlNotebook sqlPageSeedDML method
-&quot;reads&quot; the cells in the SqlPageNotebook (each method's result) and
-generates SQL to insert the content of the page in the database in the format
-and table expected by <a href="https://sql.ophir.dev/">SQLPage</a>.
-NOTE: we break our PascalCase convention for the name of the class since SQLPage
-is a proper noun (product name).</p>
+methods with the name of each SQLPage content that we want in the database.
+The SQLPageNotebook.create method &quot;reads&quot; the cells in SqlPageNotebook (each
+method's result) and generates SQL to insert the content of the page in the
+database in the format and table expected by SQLPage <code>sqlpage_files</code> table.</p>
 </div>
         </td>
       </tr>

diff --git a/support/docs/lib/ahc-hrsn-elt/screening/search_index.js b/support/docs/lib/ahc-hrsn-elt/screening/search_index.js
diff --git a/support/docs/lib/ahc-hrsn-elt/screening/~/OrchEngine.html b/support/docs/lib/ahc-hrsn-elt/screening/~/OrchEngine.html
@@ -280,7 +280,7 @@ <h3>Variable</h3>
   <div class="doc_entry">
     <span class="doc_entry_children">
     <code>
-      <span style="font-weight: 700;">duckdb</span><span style="font-weight: 500;">: <span>ddbs.DuckDbShell</span></span>
+      <span style="font-weight: 700;">duckdb</span><span style="font-weight: 500;">: <span>ddbo.DuckDbShell</span></span>
     </code>
     </span>
   </div>
@@ -385,7 +385,7 @@ <h3>Variable</h3>
   <div class="doc_entry">
     <span class="doc_entry_children">
     <code>
-      <span style="font-weight: 700;">ensureContent</span><span style="font-weight: 500;">(<span><span>isc<span>: <a href="../.././/~/OrchStepContext.html" class="link">OrchStepContext</a></span></span><span>, </span><span>ingestResult<span>: <span>Awaited</span>&lt;<span>ReturnType</span>&lt;OrchEngine.prototype.ingest&gt;&gt;</span></span></span>)</span>
+      <span style="font-weight: 700;">ensureContent</span><span style="font-weight: 500;">(<span><span>osc<span>: <a href="../.././/~/OrchStepContext.html" class="link">OrchStepContext</a></span></span><span>, </span><span>ingestResult<span>: <span>Awaited</span>&lt;<span>ReturnType</span>&lt;OrchEngine.prototype.ingest&gt;&gt;</span></span></span>)</span>
     </code>
     </span>
   </div>
@@ -413,7 +413,7 @@ <h3>Variable</h3>
   <div class="doc_entry">
     <span class="doc_entry_children">
     <code>
-      <span style="font-weight: 700;">ingest</span><span style="font-weight: 500;">(<span><span>isc<span>: <a href="../.././/~/OrchStepContext.html" class="link">OrchStepContext</a></span></span></span>)</span>
+      <span style="font-weight: 700;">ingest</span><span style="font-weight: 500;">(<span><span>osc<span>: <a href="../.././/~/OrchStepContext.html" class="link">OrchStepContext</a></span></span></span>)</span>
     </code>
     </span>
   </div>
@@ -444,7 +444,7 @@ <h3>Variable</h3>
   <div class="doc_entry">
     <span class="doc_entry_children">
     <code>
-      <span style="font-weight: 700;">init</span><span style="font-weight: 500;">(<span><span>isc<span>: <a href="../.././/~/OrchStepContext.html" class="link">OrchStepContext</a></span></span></span>): <span>Promise</span>&lt;<span>void</span>&gt;</span>
+      <span style="font-weight: 700;">init</span><span style="font-weight: 500;">(<span><span>osc<span>: <a href="../.././/~/OrchStepContext.html" class="link">OrchStepContext</a></span></span></span>): <span>Promise</span>&lt;<span>void</span>&gt;</span>
     </code>
     </span>
   </div>
@@ -469,7 +469,7 @@ <h3>Variable</h3>
   <div class="doc_entry">
     <span class="doc_entry_children">
     <code>
-      <span style="font-weight: 700;">prepareInit</span><span style="font-weight: 500;">(<span><span>isc<span>: <a href="../.././/~/OrchStepContext.html" class="link">OrchStepContext</a></span></span></span>): <span>Promise</span>&lt;<span>void</span>&gt;</span>
+      <span style="font-weight: 700;">prepareInit</span><span style="font-weight: 500;">(<span><span>osc<span>: <a href="../.././/~/OrchStepContext.html" class="link">OrchStepContext</a></span></span></span>): <span>Promise</span>&lt;<span>void</span>&gt;</span>
     </code>
     </span>
   </div>

diff --git a/support/docs/lib/ahc-hrsn-elt/screening/~/SQLPageNotebook.html b/support/docs/lib/ahc-hrsn-elt/screening/~/SQLPageNotebook.html
@@ -229,12 +229,21 @@ <h3>Variable</h3>
       </div>
       <div>
         <div class="doc_block_items"><div class="markdown"><p>Encapsulates <a href="https://sql.ophir.dev/">SQLPage</a> content. SqlPageNotebook has
-methods with the name of each <a href="https://sql.ophir.dev/">SQLPage</a> content that
-we want in the database. The MutationSqlNotebook sqlPageSeedDML method
-&quot;reads&quot; the cells in the SqlPageNotebook (each method's result) and
-generates SQL to insert the content of the page in the database in the format
-and table expected by <a href="https://sql.ophir.dev/">SQLPage</a>.
-NOTE: we break our PascalCase convention for the name of the class since SQLPage
+methods with the name of each SQLPage content that we want in the database.
+The SQLPageNotebook.create method &quot;reads&quot; the cells in SqlPageNotebook (each
+method's result) and generates SQL to insert the content of the page in the
+database in the format and table expected by SQLPage <code>sqlpage_files</code> table.</p>
+<p>See: <a href="https://github.com/lovasoa/SQLpage/tree/main#hosting-sql-files-directly-inside-the-database">https://github.com/lovasoa/SQLpage/tree/main#hosting-sql-files-directly-inside-the-database</a></p>
+<p>If you want to store customizations (e.g. handlebar templates, etc.) see:</p>
+<ul>
+<li><a href="https://sql.ophir.dev/custom_components.sql">https://sql.ophir.dev/custom_components.sql</a></li>
+<li><a href="https://github.com/lovasoa/SQLpage/discussions/174">https://github.com/lovasoa/SQLpage/discussions/174</a></li>
+</ul>
+<p>If you want to create JSON APIs:
+<a href="https://sql.ophir.dev/documentation.sql?component=json#component">https://sql.ophir.dev/documentation.sql?component=json#component</a></p>
+<p>If you want to execute commands (assuming appropriate security) in SQLPage:
+<a href="https://sql.ophir.dev/functions.sql?function=exec#function">https://sql.ophir.dev/functions.sql?function=exec#function</a></p>
+<p>NOTE: we break our PascalCase convention for the name of the class since SQLPage
 is a proper noun (product name).</p>
 </div><div>
   Constructors
@@ -283,6 +292,46 @@ <h3>Variable</h3>
     </span>
   </div>
 
+</div>
+<div class="doc_item" id="property_customCB">
+
+<a
+    href="#property_customCB"
+    class="anchor"
+    aria-label="Anchor"
+    tabIndex=-1
+>
+    <div style="width: 14px; height: 14px; display: inline-block;">&#128279;</div>
+</a>
+
+  <div class="doc_entry">
+    <span class="doc_entry_children">
+    <code>
+      <span style="font-weight: 700;">customCB</span><span style="font-weight: 500;"></span>
+    </code>
+    </span>
+  </div>
+
+</div>
+<div class="doc_item" id="property_sessionEntries">
+
+<a
+    href="#property_sessionEntries"
+    class="anchor"
+    aria-label="Anchor"
+    tabIndex=-1
+>
+    <div style="width: 14px; height: 14px; display: inline-block;">&#128279;</div>
+</a>
+
+  <div class="doc_entry">
+    <span class="doc_entry_children">
+    <code>
+      <span style="font-weight: 700;">sessionEntries</span><span style="font-weight: 500;">: <span>ReturnType</span>&lt;sessionEntries&gt;</span>
+    </code>
+    </span>
+  </div>
+
 </div>
 <div class="doc_item" id="property_tc">
 
@@ -408,6 +457,26 @@ <h3>Variable</h3>
     </span>
   </div>
 
+</div>
+<div class="doc_item" id="method_sessions.sql_0">
+
+<a
+    href="#method_sessions.sql_0"
+    class="anchor"
+    aria-label="Anchor"
+    tabIndex=-1
+>
+    <div style="width: 14px; height: 14px; display: inline-block;">&#128279;</div>
+</a>
+
+  <div class="doc_entry">
+    <span class="doc_entry_children">
+    <code>
+      <span style="font-weight: 700;">sessions.sql</span><span style="font-weight: 500;">()</span>
+    </code>
+    </span>
+  </div>
+
 </div>
 <div class="doc_item" id="method_shell_0">