Merge remote-tracking branch 'origin/main'

# Conflicts: # Writerside/topics/Overview.md
freemocap · Dec 31, 2023 · 5b568d9 · 5b568d9
2 parents 2709a7c + 9023f38
commit 5b568d9
Show file tree

Hide file tree

Showing 61 changed files with 530 additions and 123 deletions.
diff --git a/.github/workflows/writerside-docs-deploy.yml b/.github/workflows/writerside-docs-deploy.yml
@@ -0,0 +1,104 @@
+name: Build documentation
+
+on:
+  # If specified, the workflow will be triggered automatically once you push to the `main` branch.
+  # Replace `main` with your branch’s name
+  push:
+    branches: ["main"]
+  # Specify to run a workflow manually from the Actions tab on GitHub
+  workflow_dispatch:
+
+
+# Gives the workflow permissions to clone the repo and create a page deployment
+permissions:
+  id-token: write
+  pages: write
+
+env:
+  # Name of module and id separated by a slash
+  INSTANCE: SkellyBot/s
+  # Replace HI with the ID of the instance in capital letters
+  ARTIFACT: webHelpS2-all.zip
+  # Writerside docker image version
+  DOCKER_VERSION: 232.10275
+  # Add the variable below to upload Algolia indexes
+  # Replace HI with the ID of the instance in capital letters
+#  ALGOLIA_ARTIFACT: algolia-indexes-S.zip
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Build Writerside docs using Docker
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          artifact: ${{ env.ARTIFACT }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+
+      - name: Upload documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs
+          path: |
+            artifacts/${{ env.ARTIFACT }}
+            artifacts/report.json
+          retention-days: 7
+
+#      # Add the step below to upload Algolia indexes
+#      - name: Upload algolia-indexes
+#        uses: actions/upload-artifact@v3
+#        with:
+#          name: algolia-indexes
+#          path: artifacts/${{ env.ALGOLIA_ARTIFACT }}
+#          retention-days: 7
+
+  # Add the job below and artifacts/report.json on Upload documentation step above if you want to fail the build when documentation contains errors
+  test:
+    # Requires build job results
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v1
+        with:
+          name: docs
+          path: artifacts
+
+      - name: Test documentation
+        uses: JetBrains/writerside-checker-action@v1
+        with:
+          instance: ${{ env.INSTANCE }}
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    # Requires the build job results
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: docs
+
+      - name: Unzip artifact
+        run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: dir
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1
diff --git a/Writerside/cfg/buildprofiles.xml b/Writerside/cfg/buildprofiles.xml
@@ -5,7 +5,7 @@
     <variables></variables>
     <build-profile instance="s">
         <variables>
-            <noindex-content>true</noindex-content>
+            <noindex-content>false</noindex-content>
         </variables>
     </build-profile>
 

diff --git a/Writerside/images/dunkthulu_trex_head.png b/Writerside/images/dunkthulu_trex_head.png
diff --git a/Writerside/redirection-rules.xml b/Writerside/redirection-rules.xml
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE rules SYSTEM "https://resources.jetbrains.com/writerside/1.0/redirection-rules.dtd">
+<rules>
+    <!-- format is as follows
+    <rule id="<unique id>">
+        <accepts>page.html</accepts>
+    </rule>
+    -->
+    <rule id="506358aa">
+        <description>Created after removal of "Terminology" from SkellyBotNotes</description>
+        <accepts>Terminology.html</accepts>
+    </rule>
+    <rule id="27682151">
+        <description>Created after removal of "Hosted" from SkellyBotNotes</description>
+        <accepts>Hosted.html</accepts>
+    </rule>
+    <rule id="2c3e43cf">
+        <description>Created after removal of "Models" from SkellyBotNotes</description>
+        <accepts>Models.html</accepts>
+    </rule>
+    <rule id="12e0f5a3">
+        <description>Created after removal of "VsCode-Jetbrains" from SkellyBotNotes</description>
+        <accepts>VsCode.html</accepts>
+    </rule>
+    <rule id="4fb73ff9">
+        <description>Created after removal of "IDE" from SkellyBotNotes</description>
+        <accepts>IDE.html</accepts>
+    </rule>
+    <rule id="338efcfd">
+        <description>Created after removal of "CodeEditors" from SkellyBotNotes</description>
+        <accepts>IDEs.html</accepts>
+    </rule>
+    <rule id="62db6e12">
+        <description>Created after removal of "Markdown" from SkellyBotNotes</description>
+        <accepts>Markdown.html</accepts>
+    </rule>
+    <rule id="53ef95ee">
+        <description>Created after removal of "Bots" from SkellyBotNotes</description>
+        <accepts>Bots.html</accepts>
+    </rule>
+    <rule id="186262cd">
+        <description>Created after removal of "Human" from SkellyBotNotes</description>
+        <accepts>Human.html</accepts>
+    </rule>
+    <rule id="1acc0fdc">
+        <description>Created after removal of "Speakers" from SkellyBotNotes</description>
+        <accepts>Speakers.html</accepts>
+    </rule>
+</rules>
diff --git a/Writerside/s.tree b/Writerside/s.tree
@@ -3,33 +3,104 @@
         SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
 
 <instance-profile id="s"
-                  name="SkellyBotNotes" start-page="Overview.md">
+                  name="SkellyBot" start-page="Overview.md">
 
-    <toc-element topic="Overview.md"/>
-    <toc-element topic="Terminology.md"/>
+    <toc-element topic="Overview.md">
+        <toc-element topic="SkellyBot.md">
+            <toc-element topic="JonBot.md">
+                <toc-element topic="ClassBot.md">
+                    <toc-element topic="GolemGarden.md"/>
+                </toc-element>
+            </toc-element>
+        </toc-element>
+    </toc-element>
+    <toc-element topic="Concepts.md">
+        <toc-element topic="ContextRoute.md">
+            <toc-element topic="User.md">
+                <toc-element topic="Interfaces.md">
+                    <toc-element topic="FileEditors.md">
+                        <toc-element topic="JetBrains.md"/>
+                        <toc-element topic="VsCode.md"/>
+                        <toc-element topic="Obsidian.md"/>
+                    </toc-element>
+                    <toc-element topic="ChatServices.md">
+                        <toc-element topic="Discord.md">
+                            <toc-element topic="Server.md">
+                                <toc-element topic="ForumChannel.md">
+                                    <toc-element topic="ForumPost.md"/>
+                                </toc-element>
+                                <toc-element topic="Channel.md">
+                                    <toc-element topic="Thread.md"/>
+                                </toc-element>
+                                <toc-element topic="Category.md"/>
+                            </toc-element>
+                        </toc-element>
+                        <toc-element topic="Slack.md"/>
+                    </toc-element>
+                </toc-element>
+            </toc-element>
+        </toc-element>
+        <toc-element topic="RawDataTypes.md">
+            <toc-element topic="Chat.md">
+                <toc-element topic="Couplet.md">
+                    <toc-element topic="HumanMessage.md">
+                        <toc-element topic="AiResponse.md"/>
+                    </toc-element>
+                </toc-element>
+            </toc-element>
+            <toc-element topic="AudioData.md">
+                <toc-element topic="AiGeneratedAudio.md"/>
+                <toc-element topic="HumanProvidedAudio.md"/>
+            </toc-element>
+            <toc-element topic="ImageData.md">
+                <toc-element topic="AiGeneratedImage.md"/>
+                <toc-element topic="HumanProvidedImage.md"/>
+            </toc-element>
+            <toc-element topic="TextData.md">
+                <toc-element topic="AiText.md"/>
+                <toc-element topic="HumanText.md">
+                    <toc-element topic="HumanChatText.md"/>
+                    <toc-element topic="HumanProvidedText.md">
+                    </toc-element>
+                </toc-element>
+            </toc-element>
+        </toc-element>
+    </toc-element>
     <toc-element topic="ProjectNotes.md">
         <toc-element topic="Chatbot.md">
-            <toc-element topic="Agent.md">
-                <toc-element topic="LLMChain.md"/>
-                <toc-element topic="ConversationMemory.md"/>
-                <toc-element topic="LongTermMemory.md">
-                    <toc-element topic="VectorStore.md"/>
+            <toc-element topic="AI.md">
+                <toc-element topic="LangChain.md">
+                    <toc-element topic="OpenAI.md"/>
+                </toc-element>
+                <toc-element topic="Audio.md">
+                    <toc-element topic="Whisper.md"/>
                 </toc-element>
-                <toc-element topic="AgentTools.md"/>
+                <toc-element topic="Language.md">
+                    <toc-element topic="Agent.md">
+                        <toc-element topic="LLMChain.md">
+                            <toc-element topic="LargeLanguageModel-LLM.md">
+                                <toc-element topic="Gpt-4-turbo.md"/>
+                            </toc-element>
+                            <toc-element topic="SystemPrompt.md"/>
+                        </toc-element>
+                        <toc-element topic="ConversationMemory.md"/>
+                        <toc-element topic="LongTermMemory.md">
+                            <toc-element topic="VectorStore.md"/>
+                        </toc-element>
+                        <toc-element topic="AgentTools.md"/>
+                    </toc-element>
+                </toc-element>
+                <toc-element topic="Images.md">
+                    <toc-element topic="StableDiffusion.md"/>
+                    <toc-element topic="Dalle3.md">
+                    </toc-element>
+                </toc-element>
+            </toc-element>
+            <toc-element topic="FileSystem.md">
+                <toc-element topic="Foam.md"/>
+                <toc-element topic="ContinueDev.md"/>
             </toc-element>
-            <toc-element topic="FileSystem.md"/>
             <toc-element topic="TimedEvents.md"/>
         </toc-element>
     </toc-element>
-    <toc-element topic="Concepts.md">
-        <toc-element topic="ContextRoute.md"/>
-        <toc-element topic="LangChain.md"/>
-        <toc-element topic="HumanText.md"/>
-        <toc-element topic="User.md"/>
-        <toc-element topic="AiResponse.md"/>
-        <toc-element topic="Chat.md"/>
-        <toc-element topic="SystemPrompt.md"/>
-        <toc-element topic="HumanMessage.md"/>
-        <toc-element topic="Couplet.md"/>
-    </toc-element>
 </instance-profile>
diff --git a/Writerside/topics/AI.md b/Writerside/topics/AI.md
@@ -0,0 +1,3 @@
+# AI Services
+
+Some kinda magic rectangle what you can talk to?
diff --git a/Writerside/topics/Agent.md b/Writerside/topics/Agent.md
@@ -1,8 +1,8 @@
-# AiAgent
+# Agent
 
 
 ## Description
-Create an Agent using [Langchain]
+An Ai Agent using [Langchain](LangChain.md)
 
 - see https://www.langchain.com/use-case/agents
 

diff --git a/Writerside/topics/AiGeneratedAudio.md b/Writerside/topics/AiGeneratedAudio.md
@@ -0,0 +1,3 @@
+# AiGeneratedAudio
+
+Audio an [AI](AI.md) generated from text
diff --git a/Writerside/topics/AiGeneratedImage.md b/Writerside/topics/AiGeneratedImage.md
@@ -0,0 +1,3 @@
+# AiGeneratedImage
+
+A picture an AI made from [TextData](TextData.md)
diff --git a/Writerside/topics/AiResponse.md b/Writerside/topics/AiResponse.md
@@ -1,4 +1,4 @@
-# AiResponse
+# AiResponse🤖
 
 A response from an AI, always paired with a [HumanMessage](HumanMessage.md) in a [Couplet](Couplet.md)
 

diff --git a/Writerside/topics/AiText.md b/Writerside/topics/AiText.md
@@ -0,0 +1,5 @@
+# AiText
+
+This is text that was produced by an AI
+
+This is one of the two kinds of [RawTextData](RawTextData.md) (the other being [HumanText](HumanText.md))
diff --git a/Writerside/topics/Audio.md b/Writerside/topics/Audio.md
@@ -0,0 +1,11 @@
+# Audio
+
+Either: 
+- [HumanProvidedAudio](HumanProvidedAudio.md) -> 
+  - [AiTranscriptionText](AiTranscriptionText.md) (via [Whisper](Whisper.md))-> 
+    - [LLMChain](LLMChain.md) -> 
+      - [AiResponse](AiResponse.md), or 
+- [HumanProvidedText](HumanProvidedText.md) -> 
+  - [AiGeneratedAudio](AiGeneratedAudio.md) (e.g. via [OpenAi](OpenAI.md))
+
+
diff --git a/Writerside/topics/AudioData.md b/Writerside/topics/AudioData.md
@@ -0,0 +1,3 @@
+# AudioData
+
+Start typing here...
diff --git a/Writerside/topics/Bots.md b/Writerside/topics/Bots.md
@@ -0,0 +1,3 @@
+# Bots
+
+Start typing here...
diff --git a/Writerside/topics/Category.md b/Writerside/topics/Category.md
@@ -0,0 +1,5 @@
+# Category
+
+A Category is parent to either
+    - [Channels](Channel.md), or
+    - [ForumChannels](ForumChannel.md)
diff --git a/Writerside/topics/Channel.md b/Writerside/topics/Channel.md
@@ -0,0 +1,4 @@
+# Channel
+
+A Channel in a [Discord](Discord.md) [Server](Server.md)
+    - Usually under a [Category](Category.md)
diff --git a/Writerside/topics/Chat.md b/Writerside/topics/Chat.md
@@ -1,2 +1,4 @@
-# Chat
-A conversation between a [User](User.md) and an Ai [Agent](Agent.md)
+# Chat 🌿
+A conversation between a [User](User.md) and an Ai [Agent](Agent.md)
+
+- A Chat is composed of a list of linked [Couplets](Couplet.md)
diff --git a/Writerside/topics/ChatServices.md b/Writerside/topics/ChatServices.md
@@ -0,0 +1,3 @@
+# ChatServices
+
+Start typing here...
diff --git a/Writerside/topics/ClassBot.md b/Writerside/topics/ClassBot.md
@@ -0,0 +1,8 @@
+# ChatBot
+
+The first incarnation of the [ClassBot](Classbot.md) use case: 
+
+Code lives here - https://github.com/jonmatthis/chatbot
+Write up here - https://github.com/jonmatthis/chatbot/blob/main/notes/post_class_write_up.md
+
+This bot emerged as the 'buttoned down' version of our initial AI explorations in the [GolemGarden](GolemGarden.md)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# AI Services

		Some kinda magic rectangle what you can talk to?
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# AiGeneratedAudio

		Audio an [AI](AI.md) generated from text
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# AiGeneratedImage

		A picture an AI made from [TextData](TextData.md)