chore: update docs
This commit is contained in:
parent
58c088833a
commit
b380f63cf6
GPG key ID:
1020A035E5DD0824
12 changed files with 160 additions and 3712 deletions
|
|
@ -1,128 +1,116 @@
|
|||
# Documentation Sync - Code Anpassungen Todo-Liste
|
||||
# Documentation Sync - Code Adjustments Todo List
|
||||
|
||||
**Erstellt:** 2026-01-13
|
||||
**Zweck:** Liste aller Code-Anpassungen, die basierend auf der Dokumentations-Synchronisation identifiziert wurden
|
||||
**Created:** 2026-01-13
|
||||
**Purpose:** List of all code adjustments identified based on documentation synchronization
|
||||
|
||||
---
|
||||
|
||||
## Entfernte Dokumentationsdateien
|
||||
## Code Adjustments (Priority: Low)
|
||||
|
||||
### 1. `docs/test-status-membership-fee-ui.md`
|
||||
**Grund:** Veraltete temporäre Analyse-Dokumentation
|
||||
- Enthält nur historische Test-Status-Informationen (Datum: 2025-01-XX)
|
||||
- Status "Tests Written - Implementation Complete" ist nicht mehr relevant
|
||||
- Alle Tests sind bereits implementiert und laufen
|
||||
- Informationen sind bereits in `development-progress-log.md` dokumentiert
|
||||
- **Entfernt:** 2026-01-13
|
||||
### 1. Domain Public API Documentation Incomplete
|
||||
|
||||
### 2. `docs/test-failures-analysis.md`
|
||||
**Grund:** Veraltete temporäre Analyse-Dokumentation
|
||||
- Analysiert 5 fehlschlagende Tests, die bereits behoben wurden
|
||||
- Enthält Lösungsvorschläge für bereits gelöste Probleme
|
||||
- Informationen sind nur historisch relevant
|
||||
- Keine aktuelle Relevanz für die Codebasis
|
||||
- **Entfernt:** 2026-01-13
|
||||
**Problem:** The `@moduledoc` in domain modules does not list all public functions.
|
||||
|
||||
## Als veraltet markierte Dokumentationsdateien
|
||||
**Affected Files:**
|
||||
- `lib/membership/membership.ex` - Missing functions in Public API:
|
||||
- `list_required_custom_fields/0`
|
||||
- `update_member_field_visibility/2`
|
||||
- `update_single_member_field_visibility/3`
|
||||
- `lib/accounts/accounts.ex` - Very short Public API documentation, could be more detailed
|
||||
- `lib/membership_fees/membership_fees.ex` - Public API is complete, but could more clearly document that LiveViews use direct Ash calls
|
||||
|
||||
### 3. `docs/sidebar-analysis-current-state.md`
|
||||
**Grund:** Veraltete Analyse-Dokumentation
|
||||
- Beschreibt den Zustand VOR der Sidebar-Implementierung
|
||||
- Sidebar wurde bereits implementiert (2026-01-12, PR #260)
|
||||
- Wurde durch `sidebar-requirements-v2.md` ersetzt
|
||||
- **Status:** Als veraltet markiert, aber behalten für historische Referenz
|
||||
**Priority:** Low (Documentation, no functionality affected)
|
||||
|
||||
### 4. `docs/umsetzung-sidebar.md`
|
||||
**Grund:** Veraltete Implementierungs-Anleitung
|
||||
- Schritt-für-Schritt-Anleitung für Sidebar-Implementierung
|
||||
- Sidebar wurde bereits implementiert (2026-01-12, PR #260)
|
||||
- Wurde durch `sidebar-requirements-v2.md` ersetzt
|
||||
- **Status:** Als veraltet markiert, aber behalten für historische Referenz
|
||||
**Recommendation:** Update Public API sections in all domain modules to list all public functions.
|
||||
|
||||
---
|
||||
### 2. Outdated Comments in MemberLive.Form
|
||||
|
||||
## Code-Anpassungen (Priorität: Low)
|
||||
**Problem:** `@moduledoc` in `lib/mv_web/live/member_live/form.ex` still mentions "Payment Data: Mockup section (not editable)", but Membership Fees are now fully implemented.
|
||||
|
||||
### Keine kritischen Code-Anpassungen erforderlich
|
||||
**Affected File:**
|
||||
- `lib/mv_web/live/member_live/form.ex` (Line 16)
|
||||
|
||||
Die Dokumentations-Synchronisation hat ergeben, dass der Code aktuell ist und mit der aktualisierten Dokumentation übereinstimmt. Alle identifizierten Unstimmigkeiten waren in der Dokumentation, nicht im Code.
|
||||
**Priority:** Low (Documentation, no functionality affected)
|
||||
|
||||
---
|
||||
**Recommendation:** Update `@moduledoc` to reflect the current status.
|
||||
|
||||
## Veraltete Code-Patterns
|
||||
### 3. Mv.Accounts Domain Public API Missing Completely
|
||||
|
||||
### Keine veralteten Patterns identifiziert
|
||||
**Problem:** The `@moduledoc` in `lib/accounts/accounts.ex` does not mention any Public API functions, although several are defined.
|
||||
|
||||
Alle Code-Patterns entsprechen den aktuellen Best Practices und sind in `CODE_GUIDELINES.md` dokumentiert.
|
||||
**Affected File:**
|
||||
- `lib/accounts/accounts.ex` - Missing Public API documentation for:
|
||||
- `create_user/1`
|
||||
- `list_users/0`
|
||||
- `update_user/2`
|
||||
- `destroy_user/1`
|
||||
- `create_register_with_rauthy/1`
|
||||
- `read_sign_in_with_rauthy/1`
|
||||
|
||||
---
|
||||
**Priority:** Low (Documentation, no functionality affected)
|
||||
|
||||
## Fehlende Implementierungen
|
||||
**Recommendation:** Add Public API section to `@moduledoc`, similar to other domain modules.
|
||||
|
||||
### Keine fehlenden Implementierungen identifiziert
|
||||
### 4. Mv.Authorization Domain Public API Missing get_role/1
|
||||
|
||||
Alle in der Dokumentation beschriebenen Features sind implementiert.
|
||||
**Problem:** The `@moduledoc` in `lib/mv/authorization/authorization.ex` does not list `get_role/1` in the Public API, although it is defined.
|
||||
|
||||
---
|
||||
**Affected File:**
|
||||
- `lib/mv/authorization/authorization.ex` - Missing function in Public API:
|
||||
- `get_role/1` (is defined, but not mentioned in Public API)
|
||||
|
||||
## Inconsistente Namensgebung
|
||||
**Priority:** Low (Documentation, no functionality affected)
|
||||
|
||||
### Keine Inkonsistenzen identifiziert
|
||||
**Recommendation:** Add `get_role/1` to the Public API list.
|
||||
|
||||
Die Terminologie ist konsistent zwischen Code und Dokumentation:
|
||||
- `CustomField` / `CustomFieldValue` (nicht mehr "Property" / "PropertyType")
|
||||
- `MembershipFeeType` / `MembershipFeeCycle` (korrekt verwendet)
|
||||
- Domains: `Accounts`, `Membership`, `MembershipFees`, `Authorization` (alle korrekt)
|
||||
### 5. Remove Deprecated Implementations
|
||||
|
||||
---
|
||||
**Problem:** `lib/mv_web/live/custom_field_value_live/show.ex` `MvWeb.ContributionTypeLive.Index` and `MvWeb.ContributionPeriodLive.Show` are deprecated, they should be removed.
|
||||
|
||||
## Zusammenfassung
|
||||
### 6. Missing Tests for Some LiveViews
|
||||
|
||||
**Status:** ✅ Dokumentation erfolgreich synchronisiert
|
||||
**Problem:** Some LiveViews do not have corresponding test files.
|
||||
|
||||
- **Aktualisierte Dokumentation:** 15+ Dateien
|
||||
- database_schema.dbml (Version 1.4, +2 Tabellen: roles, settings)
|
||||
- database-schema-readme.md (9 Tabellen, 4 Domains, aktualisierte Relationships)
|
||||
- development-progress-log.md (Last Updated: 2026-01-13)
|
||||
- Neue Sektion: "Recent Updates (2025-12-02 to 2026-01-13)"
|
||||
- Membership Fees System Implementation (6 PRs dokumentiert)
|
||||
- Custom Fields Enhancements (3 PRs dokumentiert)
|
||||
- UI/UX Improvements (6 PRs dokumentiert)
|
||||
- Roles and Permissions System (vollständig dokumentiert)
|
||||
- Key Achievements aktualisiert (100+ PRs, 9+ sprints)
|
||||
- feature-roadmap.md (Last Updated: 2026-01-13)
|
||||
- Routes aktualisiert (alle aktuellen LiveView-Routes dokumentiert)
|
||||
- Membership Fees Endpoints (Status: ✅ Implemented)
|
||||
- Admin Panel Endpoints (Status aktualisiert)
|
||||
- Custom Fields Endpoints (korrigiert: über /settings verwaltet)
|
||||
- CHANGELOG.md (neue Features dokumentiert)
|
||||
- CODE_GUIDELINES.md (Module-Struktur, Actor-Handling-Patterns, navbar → sidebar)
|
||||
- roles-and-permissions-architecture.md (Status: ✅ Implemented)
|
||||
- roles-and-permissions-overview.md (Status: ✅ Implemented)
|
||||
- roles-and-permissions-implementation-plan.md (Status: ✅ Implemented)
|
||||
- membership-fee-architecture.md (Status: ✅ Implemented)
|
||||
- membership-fee-overview.md (Status: ✅ Implemented)
|
||||
- csv-member-import-v1.md (Status: Templates Created)
|
||||
- sidebar-requirements-v2.md (Status: ✅ Implemented)
|
||||
- README.md (Feature-Status aktualisiert)
|
||||
- **Entfernte Dokumentation:** 2 Dateien
|
||||
- test-status-membership-fee-ui.md
|
||||
- test-failures-analysis.md
|
||||
- **Als veraltet markiert:** 2 Dateien
|
||||
- sidebar-analysis-current-state.md
|
||||
- umsetzung-sidebar.md
|
||||
- **Code-Anpassungen erforderlich:** 0
|
||||
- **Kritische Probleme:** 0
|
||||
**Affected LiveViews:**
|
||||
- `MvWeb.UserLive.Show` - No test present
|
||||
- `MvWeb.RoleLive.Show` - No test present
|
||||
|
||||
**Dokumentierte Features seit 2025-12-02:**
|
||||
- Membership Fees System (6 PRs: #275, #276, #277, #278, #279, #280)
|
||||
- Custom Fields Enhancements (3 PRs: #196, #274, #282)
|
||||
- UI/UX Improvements (6 PRs: #209, #220, #231, #233, #273, #281)
|
||||
- Roles and Permissions (5 PRs: #321, #322, #323, #325, #345)
|
||||
- Sidebar Implementation (#260)
|
||||
- Member Field Settings (#223, #300)
|
||||
- CSV Import Templates (#329)
|
||||
- Actor Handling Refactoring
|
||||
- Internationalization Improvements
|
||||
**Priority:** Medium (Test coverage could be improved)
|
||||
|
||||
Die Dokumentation ist jetzt vollständig mit dem aktuellen Code synchronisiert. Alle "Last Updated" Daten wurden auf 2026-01-13 aktualisiert, wo relevant. Alle Routes, Features und Implementierungen sind dokumentiert.
|
||||
**Recommendation:** Add tests for the three Show LiveViews to ensure complete test coverage.
|
||||
|
||||
### 7. Mv.Accounts.Token @moduledoc Too Short
|
||||
|
||||
**Problem:** The `@moduledoc` in `lib/accounts/token.ex` is very short and not informative.
|
||||
|
||||
**Affected File:**
|
||||
- `lib/accounts/token.ex` - Currently only: "AshAuthentication specific ressource"
|
||||
|
||||
**Priority:** Low (Documentation, no functionality affected)
|
||||
|
||||
**Recommendation:** Expand @moduledoc to explain that this is an AshAuthentication Token Resource and is used for session management.
|
||||
|
||||
### 8. PageController Missing @moduledoc
|
||||
|
||||
**Problem:** The `@moduledoc` in `lib/mv_web/controllers/page_controller.ex` is completely missing.
|
||||
|
||||
**Affected File:**
|
||||
- `lib/mv_web/controllers/page_controller.ex` - No @moduledoc present
|
||||
|
||||
**Priority:** Low (Documentation, no functionality affected)
|
||||
|
||||
**Recommendation:** Add @moduledoc to explain that this controller renders the homepage.
|
||||
|
||||
**Note:** Other controller modules (Router, Endpoint, Telemetry) also do not have @moduledoc, but this is common and acceptable for standard Phoenix modules.
|
||||
|
||||
## Analysis Summary
|
||||
|
||||
### Found Inconsistencies
|
||||
|
||||
**1. Domain Public API Documentation Incomplete** (see Code Adjustments #1)
|
||||
**2. Outdated Comments in MemberLive.Form** (see Code Adjustments #2)
|
||||
**3. Mv.Accounts Domain Public API Missing Completely** (see Code Adjustments #3)
|
||||
**4. Mv.Authorization Domain Public API Missing get_role/1** (see Code Adjustments #4)
|
||||
**5. CustomFieldValueLive.Show is Deprecated** (see Code Adjustments #5)
|
||||
**6. Missing Tests for Some LiveViews** (see Code Adjustments #6)
|
||||
**7. Mv.Accounts.Token @moduledoc Too Short** (see Code Adjustments #7)
|
||||
**8. PageController Missing @moduledoc** (see Code Adjustments #8)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue