Skip to content

Commit

Permalink
tweaking docs - make less 'capstoney'
Browse files Browse the repository at this point in the history
  • Loading branch information
jonmatthis committed Feb 22, 2024
1 parent 99fcc77 commit 9c89bdf
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 57 deletions.
100 changes: 50 additions & 50 deletions Writerside/s.tree
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,54 @@
name="SkellyBot" start-page="Overview.md">

<toc-element topic="Overview.md">
</toc-element>
<toc-element topic="User-Guides.md">
<toc-element topic="SkellyBot-Server-Setup-Guide.md"/>
<toc-element topic="Development.md">
<toc-element topic="ProjectNotes.md"/>
<toc-element topic="Onboarding.md"/>
<toc-element topic="Environment-Setup.md"/>
<toc-element topic="Discord-Server-User-Reference.md">
<toc-element topic="Server-Structure.md"/>
<toc-element topic="Discord-Actions.md"/>
<toc-element topic="AI-Bot-Interactions.md"/>
<toc-element topic="AI-s-Context-Window.md"/>
</toc-element>
<toc-element topic="2024-02-12-JSM-Notes.md"/>
</toc-element>
<toc-element topic="Concepts.md">
<toc-element topic="Chatbot.md">
<toc-element topic="User-Interface.md"/>
<toc-element topic="AI.md">
<toc-element topic="Tools.md">
<toc-element topic="Chroma.md"/>
<toc-element topic="Foam.md"/>
<toc-element topic="ContinueDev.md"/>
<toc-element topic="OpenAI.md"/>
<toc-element topic="LangChain.md"/>
</toc-element>
<toc-element topic="Audio.md">
<toc-element topic="Whisper.md"/>
</toc-element>
<toc-element topic="Language.md">
<toc-element topic="Retrieval-Augmented-Generation.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 topic="FileSystem.md"/>
<toc-element topic="TimedEvents.md"/>
</toc-element>
<toc-element topic="SkellyBot.md">
<toc-element topic="JonBot.md">
<toc-element topic="ClassBot.md">
Expand Down Expand Up @@ -74,49 +113,10 @@
</toc-element>
</toc-element>
</toc-element>
<toc-element topic="Chatbot.md">
<toc-element topic="User-Interface.md"/>
<toc-element topic="AI.md">
<toc-element topic="Tools.md">
<toc-element topic="Chroma.md"/>
<toc-element topic="Foam.md"/>
<toc-element topic="ContinueDev.md"/>
<toc-element topic="OpenAI.md"/>
<toc-element topic="LangChain.md"/>
</toc-element>
<toc-element topic="Audio.md">
<toc-element topic="Whisper.md"/>
</toc-element>
<toc-element topic="Language.md">
<toc-element topic="Retrieval-Augmented-Generation.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 topic="FileSystem.md"/>
<toc-element topic="TimedEvents.md"/>
</toc-element>
<toc-element topic="User-Guides.md">
<toc-element topic="Discord-Server-User-Reference.md">
<toc-element topic="Server-Structure.md"/>
<toc-element topic="Discord-Actions.md"/>
<toc-element topic="AI-Bot-Interactions.md"/>
<toc-element topic="AI-s-Context-Window.md"/>
</toc-element>
<toc-element topic="Development.md">
<toc-element topic="2024-02-12-JSM-Notes.md"/>
<toc-element topic="ProjectNotes.md"/>
<toc-element topic="Onboarding.md"/>
<toc-element topic="Environment-Setup.md"/>
</toc-element>
</instance-profile>
</instance-profile>
4 changes: 2 additions & 2 deletions Writerside/topics/Discord-Server-User-Reference.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Discord Project Server User Reference
# Setting up your SkellyBot discord server

Start typing here...
Start typing here...
13 changes: 8 additions & 5 deletions Writerside/topics/Server-Structure.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
# Project Server Structure
# Setting Up Your SkellyBot Server πŸ€–πŸŒ±

## πŸ“‚πŸ“„ - Server Structure: Folders and Documents
Think of the server as **hierarchically organized text**, the same way a **folder tree** is where you store **document files** on a standard computer.

## πŸ“‚ The "folders"
**server** -
- / **category**
- / **channel** -- where chatting starts to happen, between you and me, or just your own notes
- / **thread** -- conversations that pop up INSIDE channels. AI chats are **always ** contained to threads.
- / **channel**
- You can start a [chat](Chat.md)] in a channel by typing `/chat` in the message box and hitting enter.
- This will open a [thread](Thread.md) in the channel.
- This is where you can talk back-and-forth with SkellyBot, who will respond to every message in the new thread with an AI-generated response.


## πŸ“„ The "documents": Messages are just wrappers for Markdown Documents
## πŸ“„ The "documents": Think of each [**message**] in a [Discord](Discord.md) chat as a [markdown](https://www.markdownguide.org/cheat-sheet/) Documents
The **contents** of these "folders" are the `messages`. Yes, when we're just chatting we keep these short, but ultimately they are `documents`. They **render** *all* __sorts__ of `markdown`
## including
### headings
Expand All @@ -29,4 +32,4 @@ This is why we're not really using external tools-- everything you write in `mar
- πŸ€– - add new `bot instructions` messages
- πŸ“ - edit `channel topics`
- πŸ”- others only have `read` permissions by default
- πŸ”’ - but `private` channels can still be created as desired
- πŸ”’ - but `private` channels can still be created as desired

0 comments on commit 9c89bdf

Please sign in to comment.