diff --git a/.github/workflows/writerside-docs-deploy.yml b/.github/workflows/writerside-docs-deploy.yml new file mode 100644 index 0000000..b0d7d0a --- /dev/null +++ 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 \ No newline at end of file diff --git a/Writerside/cfg/buildprofiles.xml b/Writerside/cfg/buildprofiles.xml index 8aab704..396c2d1 100644 --- a/Writerside/cfg/buildprofiles.xml +++ b/Writerside/cfg/buildprofiles.xml @@ -5,7 +5,7 @@ - true + false diff --git a/Writerside/images/dunkthulu_trex_head.png b/Writerside/images/dunkthulu_trex_head.png new file mode 100644 index 0000000..1724a30 Binary files /dev/null and b/Writerside/images/dunkthulu_trex_head.png differ diff --git a/Writerside/redirection-rules.xml b/Writerside/redirection-rules.xml new file mode 100644 index 0000000..37f816c --- /dev/null +++ b/Writerside/redirection-rules.xml @@ -0,0 +1,49 @@ + + + + + + Created after removal of "Terminology" from SkellyBotNotes + Terminology.html + + + Created after removal of "Hosted" from SkellyBotNotes + Hosted.html + + + Created after removal of "Models" from SkellyBotNotes + Models.html + + + Created after removal of "VsCode-Jetbrains" from SkellyBotNotes + VsCode.html + + + Created after removal of "IDE" from SkellyBotNotes + IDE.html + + + Created after removal of "CodeEditors" from SkellyBotNotes + IDEs.html + + + Created after removal of "Markdown" from SkellyBotNotes + Markdown.html + + + Created after removal of "Bots" from SkellyBotNotes + Bots.html + + + Created after removal of "Human" from SkellyBotNotes + Human.html + + + Created after removal of "Speakers" from SkellyBotNotes + Speakers.html + + \ No newline at end of file diff --git a/Writerside/s.tree b/Writerside/s.tree index e616034..89cd1c1 100644 --- a/Writerside/s.tree +++ b/Writerside/s.tree @@ -3,33 +3,104 @@ SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd"> + name="SkellyBot" start-page="Overview.md"> - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - \ No newline at end of file diff --git a/Writerside/topics/AI.md b/Writerside/topics/AI.md new file mode 100644 index 0000000..0de330e --- /dev/null +++ b/Writerside/topics/AI.md @@ -0,0 +1,3 @@ +# AI Services + +Some kinda magic rectangle what you can talk to? \ No newline at end of file diff --git a/Writerside/topics/Agent.md b/Writerside/topics/Agent.md index d89a7d3..a370ac4 100644 --- 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 new file mode 100644 index 0000000..016f67b --- /dev/null +++ b/Writerside/topics/AiGeneratedAudio.md @@ -0,0 +1,3 @@ +# AiGeneratedAudio + +Audio an [AI](AI.md) generated from text \ No newline at end of file diff --git a/Writerside/topics/AiGeneratedImage.md b/Writerside/topics/AiGeneratedImage.md new file mode 100644 index 0000000..61526a1 --- /dev/null +++ b/Writerside/topics/AiGeneratedImage.md @@ -0,0 +1,3 @@ +# AiGeneratedImage + +A picture an AI made from [TextData](TextData.md) \ No newline at end of file diff --git a/Writerside/topics/AiResponse.md b/Writerside/topics/AiResponse.md index 8358ce5..01e8169 100644 --- 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 new file mode 100644 index 0000000..151b851 --- /dev/null +++ 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)) \ No newline at end of file diff --git a/Writerside/topics/Audio.md b/Writerside/topics/Audio.md new file mode 100644 index 0000000..60ba528 --- /dev/null +++ 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)) + + \ No newline at end of file diff --git a/Writerside/topics/AudioData.md b/Writerside/topics/AudioData.md new file mode 100644 index 0000000..f469f9a --- /dev/null +++ b/Writerside/topics/AudioData.md @@ -0,0 +1,3 @@ +# AudioData + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/Bots.md b/Writerside/topics/Bots.md new file mode 100644 index 0000000..e61538c --- /dev/null +++ b/Writerside/topics/Bots.md @@ -0,0 +1,3 @@ +# Bots + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/Category.md b/Writerside/topics/Category.md new file mode 100644 index 0000000..082367b --- /dev/null +++ b/Writerside/topics/Category.md @@ -0,0 +1,5 @@ +# Category + +A Category is parent to either + - [Channels](Channel.md), or + - [ForumChannels](ForumChannel.md) \ No newline at end of file diff --git a/Writerside/topics/Channel.md b/Writerside/topics/Channel.md new file mode 100644 index 0000000..6583378 --- /dev/null +++ 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) \ No newline at end of file diff --git a/Writerside/topics/Chat.md b/Writerside/topics/Chat.md index 03344a2..6f7cb4c 100644 --- 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) \ No newline at end of file +# 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 new file mode 100644 index 0000000..ee8a23a --- /dev/null +++ b/Writerside/topics/ChatServices.md @@ -0,0 +1,3 @@ +# ChatServices + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/ClassBot.md b/Writerside/topics/ClassBot.md new file mode 100644 index 0000000..4ed65bb --- /dev/null +++ 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) \ No newline at end of file diff --git a/Writerside/topics/ContextRoute.md b/Writerside/topics/ContextRoute.md index 05ea87e..83307fc 100644 --- a/Writerside/topics/ContextRoute.md +++ b/Writerside/topics/ContextRoute.md @@ -9,50 +9,31 @@ The "root" of the context tree is the [User](User.md) themselves, and the leaves This diagram shows the context route tree in the Discord interface. -A given [Couplet](Couplet.md)'s route for a 'chat' that occurs in a thread would be: - -- User/ - - Interfaces/ - - Discord/ - - Servers/ - - server0_id/ - - Categories/ - - category0_id/ - - Channels/ - - channel0_id/ - - Threads/ - - thread0_id/ - - Couplets/ +A typical chat will happen in a [Thread](Thread.md) in a [Channel](Channel.md) in a [Category](Category.md). +In that case, a given [Couplet](Couplet.md)'s route for a [Chat](Chat.md) that occurs in a thread would be: + +(`id` is a a `number` that Discord provide to uniquely identify each element, get it by turning on developer tools in Discord and right-clicking any element in the UI]) + +- [User](User.md)/ + - [Interfaces](Interfaces.md)/ + - [Discord](Discord.md)/ + - [Servers](Server.md)/ + - server_[id]/ + - [Categories](Category.md)/ + - category_[id]/ + - [Channels](Channel.md)/ + - channel_[id]/ + - [Threads](Thread.md)/ + - thread_[id]/ + - [Couplets](Couplet.md)/ - couplet0 - - HumanMessage - - AiResponse - + - [HumanMessage](HumanMessage.md) + - [AiResponse](AiResponse.md) +tl;dr - ![](https://64.media.tumblr.com/90a3ea02f921c3d2d46013474136d82f/7b36ed59d1b14c9b-ec/s540x810/d14a5468e5240834f1dbcb5531fde7a14667211d.gif ) -```ad-note -title: Note on Discord "channels" contexts - -Discord has a screwy incestuous ontology - basically, everything (Channels, Threads, Forum Posts, DM's) is a 'Channel' but they act differently based ontheir subtype? - -It makes them annoying to work with (at least the way I've been using them) - -Some notes: - -- A `Thread` is a `TextChannel` (i.e. like a standard, parent `TextChannel`) -- Direct Message (`DMChannel`?) - - DM's with the Bot and the User - - Discord treats this equivalent to a Server channel/thread, but has no Guild, i think? - - Can be used to privately communicate with the User (e.g. through [[ChronJobs]]s) -- Forum Posts (`ForumChannel`) - - Forum posts are treated like channels/threads - - They can be treated MORE OR LESS interchangable with a standard `Thread` - - but there is something strange about them? - - can't remember - - -``` diff --git a/Writerside/topics/ContinueDev.md b/Writerside/topics/ContinueDev.md new file mode 100644 index 0000000..6c07db7 --- /dev/null +++ b/Writerside/topics/ContinueDev.md @@ -0,0 +1,5 @@ +# ContinueDev + +A free open source Co-Pilot clone: +- [https://continue.dev/](https://continue.dev/) +- https://github.com/continuedev/continue \ No newline at end of file diff --git a/Writerside/topics/Couplet.md b/Writerside/topics/Couplet.md index c33673f..d884e76 100644 --- a/Writerside/topics/Couplet.md +++ b/Writerside/topics/Couplet.md @@ -1,2 +1,9 @@ -# Couplet -A [HumanMessage](HumanMessage.md)/[AiResponse](AiResponse.md) pair \ No newline at end of file +# Couplet🍃 + +A [HumanMessage](HumanMessage.md)/[AiResponse](AiResponse.md) pair + - The fundamental atomic unit of a [Chat](Chat.md) + - It usually doesn't make sense to split these up (except when counting up 'Human' vs 'AI' produced text statistics) + +**SPECIAL CASE** + - The Starting message of chat might spoof the [HumanMessage](HumanMessage.md) +by copying the [User](User.md)'s starting message into a [Chatbot](Chatbot.md) message and then replying to that) \ No newline at end of file diff --git a/Writerside/topics/Dalle3.md b/Writerside/topics/Dalle3.md new file mode 100644 index 0000000..3c7d902 --- /dev/null +++ b/Writerside/topics/Dalle3.md @@ -0,0 +1,3 @@ +# Dalle3 + +An Image generation model hosted on [OpenAI](OpenAI.md) \ No newline at end of file diff --git a/Writerside/topics/Discord.md b/Writerside/topics/Discord.md new file mode 100644 index 0000000..dd8889f --- /dev/null +++ b/Writerside/topics/Discord.md @@ -0,0 +1,8 @@ +# Discord + +A Chat/Server interface - The primary focus of SkellyBot for now, because: + +- Jon uses discord to run his Class/Lab/FreeMoCap community server, so we need to target this functionality first +- Previous incarnation [JonBot](JonBot.md) was built on Discord, so easiest port of concepts + +Its children a [Server](Servers.md)s \ No newline at end of file diff --git a/Writerside/topics/FileEditors.md b/Writerside/topics/FileEditors.md new file mode 100644 index 0000000..b8cf45d --- /dev/null +++ b/Writerside/topics/FileEditors.md @@ -0,0 +1,3 @@ +# FileEditors + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/Foam.md b/Writerside/topics/Foam.md new file mode 100644 index 0000000..2919c66 --- /dev/null +++ b/Writerside/topics/Foam.md @@ -0,0 +1,3 @@ +# Foam + +A way to make [VsCode](VsCode.md) interact with Markdown like [Obsidian](Obsidian.md) does \ No newline at end of file diff --git a/Writerside/topics/ForumChannel.md b/Writerside/topics/ForumChannel.md new file mode 100644 index 0000000..17b18d6 --- /dev/null +++ b/Writerside/topics/ForumChannel.md @@ -0,0 +1,3 @@ +# ForumChannel + +A Channel that consists of a [ForumPosts](ForumPost.md), which can be treated like a [Thread](Thread.md) for all (most?) purposes \ No newline at end of file diff --git a/Writerside/topics/ForumPost.md b/Writerside/topics/ForumPost.md new file mode 100644 index 0000000..5e0ae80 --- /dev/null +++ b/Writerside/topics/ForumPost.md @@ -0,0 +1,6 @@ +# ForumPost + +The Child/Leaf of a [ForumChannel](ForumChannel.md) - These are VERY similar to a [Thread](Thread.md), +minus different methods for getting parents and whatnot (TODO - figure out specific differences ) + +For the most part, we treat these like [Thread](Thread.md)'s \ No newline at end of file diff --git a/Writerside/topics/GolemGarden.md b/Writerside/topics/GolemGarden.md new file mode 100644 index 0000000..b1d35b3 --- /dev/null +++ b/Writerside/topics/GolemGarden.md @@ -0,0 +1,13 @@ +# GolemGarden + +Golem - An artifical creation that behaves on the basis of the words shoved into its head + +- see: + - https://en.wikipedia.org/wiki/Golem + - https://en.wikipedia.org/wiki/Feet_of_Clay_(novel) + - + +Code: https://github.com/jonmatthis/golem_garden + +All Hail Dunkthulu + \ No newline at end of file diff --git a/Writerside/topics/Gpt-4-turbo.md b/Writerside/topics/Gpt-4-turbo.md new file mode 100644 index 0000000..8d971fe --- /dev/null +++ b/Writerside/topics/Gpt-4-turbo.md @@ -0,0 +1,3 @@ +# Gpt-4-turbo + +The current smartest boi - from [OpenAI](OpenAI.md) \ No newline at end of file diff --git a/Writerside/topics/Human.md b/Writerside/topics/Human.md new file mode 100644 index 0000000..08c049f --- /dev/null +++ b/Writerside/topics/Human.md @@ -0,0 +1,3 @@ +# Human + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/HumanChatText.md b/Writerside/topics/HumanChatText.md new file mode 100644 index 0000000..54c9369 --- /dev/null +++ b/Writerside/topics/HumanChatText.md @@ -0,0 +1,3 @@ +# HumanChatText + +Text the Human put straight into a [Chat](Chat.md) \ No newline at end of file diff --git a/Writerside/topics/HumanMessage.md b/Writerside/topics/HumanMessage.md index c0dbca5..7dfd4b0 100644 --- a/Writerside/topics/HumanMessage.md +++ b/Writerside/topics/HumanMessage.md @@ -1,2 +1,2 @@ -# HumanMessage +# HumanMessage🐵 A Message from a human, includes [HumanText](HumanText.md) and metadata (uuid, etc?) \ No newline at end of file diff --git a/Writerside/topics/HumanProvidedAudio.md b/Writerside/topics/HumanProvidedAudio.md new file mode 100644 index 0000000..ce54a19 --- /dev/null +++ b/Writerside/topics/HumanProvidedAudio.md @@ -0,0 +1,4 @@ +# HumanProvidedAudio + +Audio file provided by a [Human](Human.md) + - Could be a voice memo from the human or an audio file they got from somewhere else \ No newline at end of file diff --git a/Writerside/topics/HumanProvidedImage.md b/Writerside/topics/HumanProvidedImage.md new file mode 100644 index 0000000..9591e94 --- /dev/null +++ b/Writerside/topics/HumanProvidedImage.md @@ -0,0 +1,4 @@ +# HumanProvidedImage + +[ImageData](ImageData.md) the Human sent to the bot - Bot will describe and return text + diff --git a/Writerside/topics/HumanProvidedText.md b/Writerside/topics/HumanProvidedText.md new file mode 100644 index 0000000..727e9da --- /dev/null +++ b/Writerside/topics/HumanProvidedText.md @@ -0,0 +1,3 @@ +# HumanProvidedText + +Text the human provided, but didn't input directly into [Chat](Chat.md) (i.e. gathered/selected from the[FileSystem](FileSystem.md)) \ No newline at end of file diff --git a/Writerside/topics/HumanText.md b/Writerside/topics/HumanText.md index 1a66bcf..606b728 100644 --- a/Writerside/topics/HumanText.md +++ b/Writerside/topics/HumanText.md @@ -1,2 +1,4 @@ # HumanText -Text produced by a Human - the primary 'content' of a [HumanMessage](HumanMessage.md) \ No newline at end of file +This is text a human Input into an Interface of some kind (typically a [Chat](Chat.md) interface) + +This text is the primary 'content' of a [HumanMessage](HumanMessage.md) \ No newline at end of file diff --git a/Writerside/topics/ImageData.md b/Writerside/topics/ImageData.md new file mode 100644 index 0000000..8b8cb0a --- /dev/null +++ b/Writerside/topics/ImageData.md @@ -0,0 +1,3 @@ +# ImageData + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/Images.md b/Writerside/topics/Images.md new file mode 100644 index 0000000..6c4c47e --- /dev/null +++ b/Writerside/topics/Images.md @@ -0,0 +1,12 @@ +# Images + +Either: +- Human Provides (or system auto-compiles) [TextData](TextData.md) and bot replies with [AiGeneratedImage](AiGeneratedImage.md) +- Human sends [HumanProvidedImage](HumanProvidedImage.md) and bot replies with [AiText](AiText.md) + - AiText can be fed into an [LLmChain](LLMChain.md) or [Agent](Agent.md) + +Uses: +- [OpenAI](OpenAi) + - [Dalle3](Dalle3.md), or +- [LocalModels](LocalModels.md) + - [StableDiffusion](StableDiffusion.md) diff --git a/Writerside/topics/Interfaces.md b/Writerside/topics/Interfaces.md new file mode 100644 index 0000000..b1c2012 --- /dev/null +++ b/Writerside/topics/Interfaces.md @@ -0,0 +1,3 @@ +# Interfaces + +Things what with the [User](User.md) can interact with [SkellyBot](SkellyBot.md) \ No newline at end of file diff --git a/Writerside/topics/JetBrains.md b/Writerside/topics/JetBrains.md new file mode 100644 index 0000000..ee0b951 --- /dev/null +++ b/Writerside/topics/JetBrains.md @@ -0,0 +1,5 @@ +# JetBrains + +e.g. PyCharm and JetBrains + +Lets try - [ContinueDev](ContinueDev.md) \ No newline at end of file diff --git a/Writerside/topics/JonBot.md b/Writerside/topics/JonBot.md new file mode 100644 index 0000000..985f200 --- /dev/null +++ b/Writerside/topics/JonBot.md @@ -0,0 +1,7 @@ +# JonBot + +The previous incarnation - used to run a class in Fall2023 - + +Code lives here: https://github.com/jonmatthis/jonbot + +JonBot is a refactor based on lessons learned from [ClassBot](ClassBot.md) \ No newline at end of file diff --git a/Writerside/topics/LLMChain.md b/Writerside/topics/LLMChain.md index ba4227b..44ee74b 100644 --- a/Writerside/topics/LLMChain.md +++ b/Writerside/topics/LLMChain.md @@ -1,7 +1,7 @@ # LLMChain -- [X] Prompt -- [X] LLM +- [X] [Prompt](SystemPrompt.md) +- [X] [LargeLanguageModel(LLM)](LargeLanguageModel-LLM.md) - [ ] Streaming - [ ] Via User Config - [ ] with backups/alternatives diff --git a/Writerside/topics/Language.md b/Writerside/topics/Language.md new file mode 100644 index 0000000..ec08709 --- /dev/null +++ b/Writerside/topics/Language.md @@ -0,0 +1,3 @@ +# Language + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/LargeLanguageModel-LLM.md b/Writerside/topics/LargeLanguageModel-LLM.md new file mode 100644 index 0000000..595fc2a --- /dev/null +++ b/Writerside/topics/LargeLanguageModel-LLM.md @@ -0,0 +1,7 @@ +# LargeLanguageModel(LLM) + +The Magic Box - Throw the language at it and it throws language back + +Default Model - [GPT-4-Turbo](Gpt-4-turbo.md) + +[https://js.langchain.com/docs/modules/model_io/concepts](https://js.langchain.com/docs/modules/model_io/concepts) \ No newline at end of file diff --git a/Writerside/topics/Obsidian.md b/Writerside/topics/Obsidian.md new file mode 100644 index 0000000..419fe8f --- /dev/null +++ b/Writerside/topics/Obsidian.md @@ -0,0 +1,17 @@ +# Obsidian + +A Markdown Editor + +- Possibly replaceable with [VsCode](VsCode.md) and the [Foam](Foam.md) extension + +Nice Obsidian AI Extensions: +- [https://github.com/logancyang/obsidian-copilot](https://github.com/logancyang/obsidian-copilot) + - Seems most active and up to date? + - Theoretically has [VectorStore](VectorStore.md) +- [https://github.com/brianpetro/obsidian-smart-connections](https://github.com/brianpetro/obsidian-smart-connections) + - Has nice ChatBox interface + - theoretically handles [VectorStore](VectorStore.md) +- [https://github.com/bramses/chatgpt-md](https://github.com/bramses/chatgpt-md) + - Has a very nice simple "Process this `md` file" method + - caries config in header section + - splits human/ai messages via internal HTML tag \ No newline at end of file diff --git a/Writerside/topics/OpenAI.md b/Writerside/topics/OpenAI.md new file mode 100644 index 0000000..7f0510d --- /dev/null +++ b/Writerside/topics/OpenAI.md @@ -0,0 +1,3 @@ +# OpenAI + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/Overview.md b/Writerside/topics/Overview.md index 9a2671d..a07db14 100644 --- a/Writerside/topics/Overview.md +++ b/Writerside/topics/Overview.md @@ -1,13 +1,14 @@ # Overview -Knowledge base for SkellyBot +Knowledge base for [SkellyBot](SkellyBot.md) -## [Project Notes](ProjectNotes.md) -## [Concepts](Concepts.md) + +- Project planning: [ProjectNotes](ProjectNotes.md) +- Key Concepts: [Concepts](Concepts.md) ```ad-note View in: -- Jetbrains Writerside (free route standalone Writerside app or Pycharm (etc) plugin) +- Jetbrains Writerstorm (free route standalone Writerstorm app or Pycharm (etc) plugin) - Obsidian MD - VS Code Foam ``` \ No newline at end of file diff --git a/Writerside/topics/ProjectNotes.md b/Writerside/topics/ProjectNotes.md index c685430..d63677c 100644 --- a/Writerside/topics/ProjectNotes.md +++ b/Writerside/topics/ProjectNotes.md @@ -1,17 +1,17 @@ # Project Notes ## Services: -### Discord +### [Discord](Discord) - /thread command - - [X] opens a thread in a Discord channel + - [X] opens a [Thread](Thread.md) in a Discord channel - [X] Configures a [Chatbot](Chatbot.md) for this thread - [ ] Create title card for the chat, with: - - information about chat + - information about [Chat](Chat.md) - interface to configure [Chatbot](Chatbot.md) -- Slack - - (basically what Discord is doing, but in Slack context) - - (interfacing with the `[chatbot](Chatbot.md)` module) +- [Slack](Slack.md) + - (basically what [Discord](Discord.md) is doing, but in Slack context) + - (interfacing with the [chatbot](Chatbot.md) module) - shared/ - /chatbot-core @@ -33,12 +33,10 @@ - see: https://www.langchain.com/use-case/agents - - /image - - intake text produce image - - intake image produce text - - /audio - - intake audio produce text - - intake text produce audio +- /image + - [Images](Images(Images.md) +- /audio + - [Audio](Audio.Md) # Bot lifetime management - how to manage 'long term memory'/'bot storage?' diff --git a/Writerside/topics/RawDataTypes.md b/Writerside/topics/RawDataTypes.md new file mode 100644 index 0000000..c423cf2 --- /dev/null +++ b/Writerside/topics/RawDataTypes.md @@ -0,0 +1,3 @@ +# DataTypes + +Data produced that's intellectually interesting and worth analyzing \ No newline at end of file diff --git a/Writerside/topics/Server.md b/Writerside/topics/Server.md new file mode 100644 index 0000000..3ec5f7e --- /dev/null +++ b/Writerside/topics/Server.md @@ -0,0 +1,12 @@ +# Server + +Aka a `guild` in the Discord ontology + +A [User] may join multiple servers + +Its children are either: + - [Categories](Category.md) + - Category-less [Channel](Channel.md) + - We could consider disallowing category-less channels to make the ontology cleaner + - Category-less [ForumChannel](ForumChannel) + - Announcement Channel [AnnouncementChannel](AnnouncemendChannel) \ No newline at end of file diff --git a/Writerside/topics/SkellyBot.md b/Writerside/topics/SkellyBot.md new file mode 100644 index 0000000..12fb5f2 --- /dev/null +++ b/Writerside/topics/SkellyBot.md @@ -0,0 +1,5 @@ +# SkellyBot + +The project itself, the top level concept in this space - The global root + +SkellyBot is a full refactor following lessons learned from [JonBot](JonBot.md) \ No newline at end of file diff --git a/Writerside/topics/Slack.md b/Writerside/topics/Slack.md new file mode 100644 index 0000000..016e390 --- /dev/null +++ b/Writerside/topics/Slack.md @@ -0,0 +1,3 @@ +# Slack + +Will be similar to the [Discord](Discord.md) interface, but ya know, Slacky diff --git a/Writerside/topics/Speakers.md b/Writerside/topics/Speakers.md new file mode 100644 index 0000000..6c6bce3 --- /dev/null +++ b/Writerside/topics/Speakers.md @@ -0,0 +1,5 @@ +# Speakers + +Entities that can speak: +- [Human](Human.md) (or group of humans) +- [ChatBot](Chatbot.md) - an [AI](AI.md) enabled bot that responds to the Human in an [Interface](Interfaces.md) \ No newline at end of file diff --git a/Writerside/topics/StableDiffusion.md b/Writerside/topics/StableDiffusion.md new file mode 100644 index 0000000..02582fc --- /dev/null +++ b/Writerside/topics/StableDiffusion.md @@ -0,0 +1,3 @@ +# StableDiffusion + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/SystemPrompt.md b/Writerside/topics/SystemPrompt.md index 717f238..94983cf 100644 --- a/Writerside/topics/SystemPrompt.md +++ b/Writerside/topics/SystemPrompt.md @@ -2,4 +2,6 @@ The words stuffed into the [LLMChain](LLMChain.md)'s head that tell it what to do -https://platform.openai.com/docs/guides/prompt-engineering \ No newline at end of file +[https://js.langchain.com/docs/modules/model_io/concepts#systemmessage](https://js.langchain.com/docs/modules/model_io/concepts#systemmessage) + +[https://platform.openai.com/docs/guides/prompt-engineering](https://js.langchain.com/docs/modules/model_io/concepts#systemmessage) \ No newline at end of file diff --git a/Writerside/topics/Terminology.md b/Writerside/topics/Terminology.md deleted file mode 100644 index 3767602..0000000 --- a/Writerside/topics/Terminology.md +++ /dev/null @@ -1,34 +0,0 @@ -# Terminology - -A reference article is information-oriented. -It provides a structured description of a product: -its APIs, classes, functions, configuration options, actions, and so on. -Start with a summary of what this reference article is about, and what the items you are describing are used for. - -## Command - -Syntax: - -```shell -cmd [OPTIONS] -``` - -## Options - -Describe what each option is used for: - --o, --open -: Opens a file. - --c, --close -: Closes a file. - --v, --version -: Displays version information. - --h, --help -: Displays help. - - - - \ No newline at end of file diff --git a/Writerside/topics/TextData.md b/Writerside/topics/TextData.md new file mode 100644 index 0000000..fb8e904 --- /dev/null +++ b/Writerside/topics/TextData.md @@ -0,0 +1,3 @@ +# TextData + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/Thread.md b/Writerside/topics/Thread.md new file mode 100644 index 0000000..64544fc --- /dev/null +++ b/Writerside/topics/Thread.md @@ -0,0 +1,7 @@ +# Thread🌿 + +This is where a [Chat](Chat.md) happens - This is a base-level datatype, even though it is technically composed of smaller atomic units (called [Couplet](Couplet.md)s) + +Kinda like how a bunch of grapes is teh output of a grapevine, even though it comprises a bunch of individual grapes 🍇 + +A Thread is composed of a set of linked [Couplets](Couplet.md) \ No newline at end of file diff --git a/Writerside/topics/VsCode.md b/Writerside/topics/VsCode.md new file mode 100644 index 0000000..f2fe912 --- /dev/null +++ b/Writerside/topics/VsCode.md @@ -0,0 +1,4 @@ +# VsCode + +Lets try - [ContinueDev](ContinueDev.md) + diff --git a/Writerside/topics/Whisper.md b/Writerside/topics/Whisper.md new file mode 100644 index 0000000..fa6321b --- /dev/null +++ b/Writerside/topics/Whisper.md @@ -0,0 +1,4 @@ +# Whisper + +- [Audio](Audio.md) transcription model from [OpenAI](OpenAI.md) +- Can be run locally? \ No newline at end of file