doc: comments for codebase and updated documentation

src/shared/lib/accessibility/motion.svelte.ts

@@ -1,6 +1,7 @@
 // Check if we are in a browser environment
 const isBrowser = typeof window !== 'undefined';
 
+// A class to manage motion preference and provide a single instance for use everywhere
 class MotionPreference {
     // Reactive state
     #reduced = $state(false);

src/shared/lib/helpers/createEntityStore/createEntityStore.svelte.ts

@@ -75,6 +75,11 @@ export class EntityStore<T extends Entity> {
     }
 }
 
+/**
+ * Creates a new EntityStore instance with the given initial entities.
+ * @param initialEntities The initial entities to populate the store with.
+ * @returns - A new EntityStore instance.
+ */
 export function createEntityStore<T extends Entity>(initialEntities: T[] = []) {
     return new EntityStore<T>(initialEntities);
 }

src/shared/lib/utils/splitArray/splitArray.ts

@@ -1,3 +1,9 @@
+/**
+ * Splits an array into two arrays based on a callback function.
+ * @param array The array to split.
+ * @param callback The callback function to determine which array to push each item to.
+ * @returns - An array containing two arrays, the first array contains items that passed the callback, the second array contains items that failed the callback.
+ */
 export function splitArray<T>(array: T[], callback: (item: T) => boolean) {
     return array.reduce<[T[], T[]]>(
         ([pass, fail], item) => (