feat: Add README files for various modules and routes
This commit is contained in:
28
src/lib/ae_archives/README.md
Normal file
28
src/lib/ae_archives/README.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Aether (AE) Archives Module
|
||||
|
||||
The Archives module is a system for storing and retrieving archived data. It is composed of two main data structures: `Archive` and `Archive_Content`.
|
||||
|
||||
## Data Structures
|
||||
|
||||
### Archive
|
||||
|
||||
An `Archive` is a container for a collection of `Archive_Content` items. It has a name, description, and other metadata.
|
||||
|
||||
### Archive Content
|
||||
|
||||
An `Archive_Content` item represents a single piece of content within an `Archive`. This can be text, a file, a URL, or other data.
|
||||
|
||||
## Functionality
|
||||
|
||||
This module provides the following functionality:
|
||||
|
||||
- **CRUD Operations:** Create, Read, Update, and Delete operations for both `Archive` and `Archive_Content` objects.
|
||||
- **Local Caching:** Uses Dexie.js to cache data in the browser's IndexedDB for offline access and faster load times.
|
||||
- **API Interaction:** All data operations are synced with the backend API.
|
||||
|
||||
## Files
|
||||
|
||||
- `ae_archives__archive.ts`: Contains functions for managing `Archive` objects.
|
||||
- `ae_archives__archive_content.ts`: Contains functions for managing `Archive_Content` objects.
|
||||
- `ae_archives_functions.ts`: Exports all the functions from the module for easy use in other parts of the application.
|
||||
- `db_archives.ts`: Defines the IndexedDB schema for the archives module using Dexie.js.
|
||||
Reference in New Issue
Block a user