Merge pull request #96 from scicloj/tutorial-v001

'Finished' site draft, complete with gotchas, faq, scientists tutorials and other information
scicloj · Aug 2, 2024 · 5b8347c · 5b8347c
2 parents e176350 + 659a855
commit 5b8347c
Show file tree

Hide file tree

Showing 21 changed files with 1,348 additions and 1,084 deletions.
diff --git a/README.md b/README.md
@@ -92,7 +92,7 @@ to generate your own wolfram ns with whatever additional symbols your Wolfram/Ma
 
 #### Learning Wolframite
 
-Read through and play with [explainer.clj](dev%2Fexplainer.clj) and [demo.clj](dev%2Fdemo.clj), which demonstrate most of Wolframite's features and what you can do with Wolfram.
+Read through and play with [explainer.clj](dev%2Fexplainer.clj) and [quickstart.clj](dev%2Fquickstart.clj), which demonstrate most of Wolframite's features and what you can do with Wolfram.
 
 #### Customizing Wolframite
 
@@ -123,7 +123,7 @@ user> (require '[clojuratica.tools.clerk-helper :as ch])
 user> (ch/clerk-watch! ["dev/notebook"])
 ```
 
-* Open dev/notebook/demo.clj, make a change and save.
+* Open dev/notebook/quickstart.clj, make a change and save.
 * Open `localhost:7777` in the browser
 
 ### How does it work?

diff --git a/clay.edn b/clay.edn
@@ -8,4 +8,4 @@
  :run-quarto true
  :format [:quarto :html]
  :hide-nils true
- :kindly/options {:kinds-that-hide-code #{:kind/md :kind/hiccup :kind/html :kind/tex}}}
+ :kindly/options {:kinds-that-hide-code #{:kind/md :kind/html :kind/video}}}
diff --git a/docs/_quarto.yml b/docs/_quarto.yml
@@ -6,8 +6,11 @@ book:
   chapters:
   - index.qmd
   - demo.qmd
-  - part: For Scientists
-    chapters: [for_scientists.index.qmd]
-  - part: For Developers
+  - gotcha.qmd
+  - packages.qmd
+  - part: Tutorials for scientists
+    chapters: [for_scientists.index.qmd, for_scientists.cavity_physics.qmd]
+  - part: Tutorials for developers
     chapters: [for_developers.index.qmd]
+  - faq.qmd
   title: Wolframite Documentation
diff --git a/docs/demo.html b/docs/demo.html
diff --git a/docs/for_developers.index.html b/docs/for_developers.index.html
@@ -2,12 +2,12 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.54">
+<meta name="generator" content="quarto-1.5.55">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 
 
-<title>4&nbsp; Wolframite for Clojure developers – Wolframite Documentation</title>
+<title>7&nbsp; Wolframite for developers – Wolframite Documentation</title>
 <style>
 code{white-space: pre-wrap;}
 span.smallcaps{font-variant: small-caps;}
@@ -30,7 +30,8 @@
 <script src="site_libs/quarto-search/fuse.min.js"></script>
 <script src="site_libs/quarto-search/quarto-search.js"></script>
 <meta name="quarto:offset" content="./">
-<link href="./for_scientists.index.html" rel="prev">
+<link href="./faq.html" rel="next">
+<link href="./for_scientists.cavity_physics.html" rel="prev">
 <script src="site_libs/quarto-html/quarto.js"></script>
 <script src="site_libs/quarto-html/popper.min.js"></script>
 <script src="site_libs/quarto-html/tippy.umd.min.js"></script>
@@ -80,7 +81,7 @@
       <button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
         <i class="bi bi-layout-text-sidebar-reverse"></i>
       </button>
-        <nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./for_developers.index.html">For Developers</a></li><li class="breadcrumb-item"><a href="./for_developers.index.html"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Wolframite for Clojure developers</span></a></li></ol></nav>
+        <nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./for_developers.index.html">Tutorials for developers</a></li><li class="breadcrumb-item"><a href="./for_developers.index.html"><span class="chapter-number">7</span>&nbsp; <span class="chapter-title">Wolframite for developers</span></a></li></ol></nav>
         <a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">      
         </a>
       <button type="button" class="btn quarto-search-button" aria-label="Search" onclick="window.quartoOpenSearch();">
@@ -114,13 +115,25 @@
         <li class="sidebar-item">
   <div class="sidebar-item-container"> 
   <a href="./demo.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text"><span class="chapter-number">2</span>&nbsp; <span class="chapter-title">Wolframite demo</span></span></a>
+ <span class="menu-text"><span class="chapter-number">2</span>&nbsp; <span class="chapter-title">Quickstart</span></span></a>
+  </div>
+</li>
+        <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="./gotcha.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text"><span class="chapter-number">3</span>&nbsp; <span class="chapter-title">Gotchas…</span></span></a>
+  </div>
+</li>
+        <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="./packages.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Packages</span></span></a>
   </div>
 </li>
         <li class="sidebar-item sidebar-item-section">
       <div class="sidebar-item-container"> 
             <a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true">
- <span class="menu-text">For Scientists</span></a>
+ <span class="menu-text">Tutorials for scientists</span></a>
           <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section">
             <i class="bi bi-chevron-right ms-2"></i>
           </a> 
@@ -129,15 +142,21 @@
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
   <a href="./for_scientists.index.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text"><span class="chapter-number">3</span>&nbsp; <span class="chapter-title">Wolframite for scientists</span></span></a>
+ <span class="menu-text"><span class="chapter-number">5</span>&nbsp; <span class="chapter-title">Wolframite for scientists I (Introduction)</span></span></a>
+  </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="./for_scientists.cavity_physics.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text"><span class="chapter-number">6</span>&nbsp; <span class="chapter-title">Wolframite for scientists II (Cavity physics)</span></span></a>
   </div>
 </li>
       </ul>
   </li>
         <li class="sidebar-item sidebar-item-section">
       <div class="sidebar-item-container"> 
             <a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true">
- <span class="menu-text">For Developers</span></a>
+ <span class="menu-text">Tutorials for developers</span></a>
           <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true" aria-label="Toggle section">
             <i class="bi bi-chevron-right ms-2"></i>
           </a> 
@@ -146,25 +165,37 @@
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
   <a href="./for_developers.index.html" class="sidebar-item-text sidebar-link active">
- <span class="menu-text"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Wolframite for Clojure developers</span></span></a>
+ <span class="menu-text"><span class="chapter-number">7</span>&nbsp; <span class="chapter-title">Wolframite for developers</span></span></a>
   </div>
 </li>
       </ul>
   </li>
+        <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="./faq.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text"><span class="chapter-number">8</span>&nbsp; <span class="chapter-title">FAQ</span></span></a>
+  </div>
+</li>
     </ul>
     </div>
 </nav>
 <div id="quarto-sidebar-glass" class="quarto-sidebar-collapse-item" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item"></div>
 <!-- margin-sidebar -->
-    <div id="quarto-margin-sidebar" class="sidebar margin-sidebar zindex-bottom">
-
+    <div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
+        <nav id="TOC" role="doc-toc" class="toc-active">
+    <h2 id="toc-title">Table of contents</h2>
+
+  <ul>
+  <li><a href="#tldr" id="toc-tldr" class="nav-link active" data-scroll-target="#tldr"><span class="header-section-number">7.1</span> TL;DR</a></li>
+  </ul>
+</nav>
     </div>
 <!-- main -->
 <main class="content" id="quarto-document-content">
 
-<header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./for_developers.index.html">For Developers</a></li><li class="breadcrumb-item"><a href="./for_developers.index.html"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Wolframite for Clojure developers</span></a></li></ol></nav>
+<header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./for_developers.index.html">Tutorials for developers</a></li><li class="breadcrumb-item"><a href="./for_developers.index.html"><span class="chapter-number">7</span>&nbsp; <span class="chapter-title">Wolframite for developers</span></a></li></ol></nav>
 <div class="quarto-title">
-<h1 class="title"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Wolframite for Clojure developers</span></h1>
+<h1 class="title"><span class="chapter-number">7</span>&nbsp; <span class="chapter-title">Wolframite for developers</span></h1>
 </div>
 
 
@@ -193,12 +224,15 @@ <h1 class="title"><span class="chapter-number">4</span>&nbsp; <span class="chapt
 </style>
 <script src="for_developers.index_files/md-default0.js" type="text/javascript"></script>
 <script src="for_developers.index_files/md-default1.js" type="text/javascript"></script>
-<p>An explanation of Wolframite and why to use it, aimed at Clojure developers.</p>
-<p>TBD</p>
+<section id="tldr" class="level2" data-number="7.1">
+<h2 data-number="7.1" class="anchored" data-anchor-id="tldr"><span class="header-section-number">7.1</span> TL;DR</h2>
+<p>We introduce you, the motivated Clojure developer, to using the Wolfram programming language as a Clojure library. Following some brief inspiration (why on earth should you do this?), and some getting started notes, we outline a ‘real’ workflow using the example of …</p>
+<span style="color:red">Coming soon!</span>
 <div style="background-color:grey;height:2px;width:100%;"></div>
 <div><pre><small><small>source: <a href="https://github.com/scicloj/wolframite/blob/main/notebooks/for_developers/index.clj">notebooks/for_developers/index.clj</a></small></small></pre></div>
 
 
+</section>
 
 </main> <!-- /main -->
 <script id="quarto-html-after-body" type="application/javascript">
@@ -623,11 +657,14 @@ <h1 class="title"><span class="chapter-number">4</span>&nbsp; <span class="chapt
 </script>
 <nav class="page-navigation">
   <div class="nav-page nav-page-previous">
-      <a href="./for_scientists.index.html" class="pagination-link" aria-label="Wolframite for scientists">
-        <i class="bi bi-arrow-left-short"></i> <span class="nav-page-text"><span class="chapter-number">3</span>&nbsp; <span class="chapter-title">Wolframite for scientists</span></span>
+      <a href="./for_scientists.cavity_physics.html" class="pagination-link" aria-label="Wolframite for scientists II (Cavity physics)">
+        <i class="bi bi-arrow-left-short"></i> <span class="nav-page-text"><span class="chapter-number">6</span>&nbsp; <span class="chapter-title">Wolframite for scientists II (Cavity physics)</span></span>
       </a>          
   </div>
   <div class="nav-page nav-page-next">
+      <a href="./faq.html" class="pagination-link" aria-label="FAQ">
+        <span class="nav-page-text"><span class="chapter-number">8</span>&nbsp; <span class="chapter-title">FAQ</span></span> <i class="bi bi-arrow-right-short"></i>
+      </a>
   </div>
 </nav>
 </div> <!-- /content -->