summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyren223 <Kyren223@proton.me>2025-07-20 17:00:26 +0300
committerKyren223 <Kyren223@proton.me>2025-07-20 17:00:26 +0300
commit3fcaf100334897e314a86a53576639410055989b (patch)
treede86e6598110f469c4945a75feeb1f4332678987
parenteda87f553a580876e98b18fde4805cdef85c69f5 (diff)
Moved tools like check-ci into tools/ and updated the glossary
-rw-r--r--CONTRIBUTING.md4
-rw-r--r--GLOSSARY.md50
-rw-r--r--mprocs.yaml2
-rwxr-xr-xreload.sh7
-rw-r--r--terminology.md23
-rwxr-xr-xtools/check-ci.sh (renamed from check-ci.sh)0
-rwxr-xr-xtools/copyright.sh (renamed from copyright.sh)0
7 files changed, 55 insertions, 31 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5d75cb2..f7b1a03 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -39,6 +39,10 @@ us know in your PR, otherwise we will assume it is a WIP.
Please only mark the pull request as "Ready for Review" when it is in fact
complete and ready for review.
+## Glosarry
+
+Check out the [Glossary](./glossary.md) to see how certain terms are used and what they mean
+
> When contributing to this project, you must agree that you have authored 100%
> of the content, (or) that you have the necessary rights to the content and
> that the content you contribute may be provided under the projects AGPLv3
diff --git a/GLOSSARY.md b/GLOSSARY.md
new file mode 100644
index 0000000..22cbc4f
--- /dev/null
+++ b/GLOSSARY.md
@@ -0,0 +1,50 @@
+# Glossary
+
+The goal is to define the meaning behind specific terminology used in this project.
+Currently this document is incomplete, it'll be improved over time, feel free to contribute improvements.
+
+## ID
+
+A snowflake ID, a snowflake ID is a unique identifier used across the client
+and server, it embeds metadata including the date it was generated which can
+be retrieved for display purposes.
+
+### User ID
+
+A snowflake ID for a user, used as the primary way to refer to a user in a
+unique way (like opening a signal with a user).
+
+### Receiver ID
+
+Usually refers to the "other" person's ID in a user-to-user messaging, but
+can also refer to the literal `receiver_id` SQL field on the `messages` table
+which may be either the "other" person, or the user itself.
+
+### Frequency ID
+
+A snowflake ID that refers to a frequency.
+
+### Chad ID
+
+A snowflake ID that refers to either a frequency ID or a receiver ID.
+
+### Signal
+
+A currently open chat between 2 individual users ("DM").
+
+## Session
+
+A struct that helps with managing a single active connection, it contains
+various metadata including the address of the connection and has methods for
+reading/writing to the connection, it is also responsible for metrics and
+rate limiting for per-connection requests.
+
+### Unauthenticated Session
+
+A session that has not yet been authenticated, so it doesn't have a User ID
+or public key yet, and has not been added to the server sessions map.
+
+### Authenticated Session
+
+A session that is authenticated and attached to a user, it has a UserID and a
+public key and it has been mapped into the server's session map.
diff --git a/mprocs.yaml b/mprocs.yaml
index 2b9319a..4efa0f9 100644
--- a/mprocs.yaml
+++ b/mprocs.yaml
@@ -10,4 +10,4 @@ procs:
messages-log:
shell: "tail -f messages.log"
check-ci:
- shell: "./check-ci.sh"
+ shell: "./tools/check-ci.sh"
diff --git a/reload.sh b/reload.sh
deleted file mode 100755
index e520ebc..0000000
--- a/reload.sh
+++ /dev/null
@@ -1,7 +0,0 @@
-# 2.1 means "1st pane of the 2nd window"
-tmux send-keys -t 2.1 C-c
-sleep 0.5
-tmux send-keys -t 2.1 clear C-m
-sleep 0.2
-tmux send-keys -t 2.1 "go run ./cmd/client" C-m
-sleep 0.2
diff --git a/terminology.md b/terminology.md
deleted file mode 100644
index d4cbe91..0000000
--- a/terminology.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# Terminology
-
-TODO
-
-## TODO
-
-ID - A snowflake ID, a snowflake ID is a unique identifier used across the client and server, it embeds metadata including the date it was generated which can be retrieved for display purposes.
-
-User ID - A snowflake ID for a user, used as the primary way to refer to a user in a unique way (like opening a signal with a user)
-
-Receiver ID - usually refers to the "other" person's ID in a 1:1 messaging, but can also refer to the literal `receiver_id` SQL field on the `messages` table which may be either the "other" person, or the user itself.
-
-Frequency ID
-
-Chat ID - A snowflake ID that refers to either a frequency ID or a receiver ID
-
-Signal - A currently open chat between 2 individual users ("DM")
-
-Session - A struct that helps with managing a single active connection, it contains the addr of the connection and has methods for reading/writing to the connection
-
-Unauthenticated Session - A session that has not yet been authenticated, so it doesn't have a User ID or public key yet, and has not been added to the server sessions map
-
-Authenticated Session - A session that is authenticated and attached to a user, it has a UserID and a public key and it has been mapped into the server's session map based on it's user ID.
diff --git a/check-ci.sh b/tools/check-ci.sh
index 2baee8a..2baee8a 100755
--- a/check-ci.sh
+++ b/tools/check-ci.sh
diff --git a/copyright.sh b/tools/copyright.sh
index cc3a612..cc3a612 100755
--- a/copyright.sh
+++ b/tools/copyright.sh