Scott.Idem/OSIT-AE-App-Svelte
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: Update ARCHITECTURE.md and COMPONENTS.md to reflect ShadCN removal and CodeMirror emphasis.

Browse Source
This commit is contained in:
Scott Idem
2025-11-13 15:40:56 -05:00
parent 03a6661360
commit 81e4d83c2d
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
ARCHITECTURE.md
View File

@@ -9,14 +9,14 @@ The Aether project is a Svelte and SvelteKit based application, utilizing Tailwi
* **Frontend Framework:** Svelte 5 and SvelteKit v2 * **Frontend Framework:** Svelte 5 and SvelteKit v2
* **Routing:** SvelteKit's file-system based routing. * **Routing:** SvelteKit's file-system based routing.
* **Styling:** Tailwind CSS 3.x (with plans to upgrade to 4.x when ShadCN is ready) * **Styling:** Tailwind CSS 3.x (with plans to upgrade to 4.x when ShadCN is ready)
* **UI Component Libraries:** * **UI Component Libraries:**
* ShadCN (Tailwind Components) * Skeleton (Design System, Tailwind Components, Functional Components - with plans to upgrade to v3)
* Skeleton (Design System, Tailwind Components, Functional Components - with plans to upgrade to v3) * Flowbite (Tailwind Components)
* Flowbite (Tailwind Components) * **Note:** ShadCN is currently used but is planned for removal.
* **Text/Code Editors:** * **Text/Code Editors:**
* CodeMirror 6.x (for text and code editing) * CodeMirror 6.x (primary text and code editor, planned for rich text editing)
* Edra (TipTap based Rich Text Editor) * Edra (TipTap based Rich Text Editor)
* **Note:** ShadEditor TipTap is present but marked for removal, with CodeMirror being the preferred solution. * **Note:** ShadEditor TipTap is present but marked for removal, with CodeMirror being the preferred solution for all text editing needs.
* **Icons:** Lucide Icons (SVG Icons) * **Icons:** Lucide Icons (SVG Icons)
* **Markdown Parsing:** `marked` library * **Markdown Parsing:** `marked` library
* **State Management:** Svelte stores, potentially with `liveQuery` from Dexie for reactive IndexedDB interactions. * **State Management:** Svelte stores, potentially with `liveQuery` from Dexie for reactive IndexedDB interactions.

6
COMPONENTS.md
View File

@@ -36,9 +36,9 @@ These are reusable components that provide common functionalities across differe
* **`copy_btn`**: A button to copy content to the clipboard. * **`copy_btn`**: A button to copy content to the clipboard.
* Properties: `clipboard`, `bind:value`, `btn_text`, `btn_html`. * Properties: `clipboard`, `bind:value`, `btn_text`, `btn_html`.
* **`txt_editor`**: A basic text area editor. * **`txt_editor`**: A basic text area editor.
* **`md_editor`**: Markdown editor. * **`md_editor`**: Markdown editor.
* Uses CodeMirror. * Uses CodeMirror (planned for rich text editing).
* **Note:** ShadEditor TipTap is present but marked for removal. * **Note:** ShadEditor TipTap is present but marked for removal. ShadCN components are also being phased out in favor of CodeMirror for text editing.
* **`html_editor`**: HTML editor. * **`html_editor`**: HTML editor.
* **`media_player`**: Component for playing media files. * **`media_player`**: Component for playing media files.
* Properties: `hosted_file`, `archive_content`, `media_player`. * Properties: `hosted_file`, `archive_content`, `media_player`.