Cleanup of the docs closes #507

moritz commented

2026-06-15 22:00:15 +02:00

Owner

Description of the implemented changes

The changes were:

Bugfixing
New Feature
Breaking Change
Refactoring

Cleanup of the /docs directory: many docs had accumulated during development. They were condensed for readability, brought back in sync with the code, and given an index, while preserving all load-bearing information. No application code behavior changes.

What has been changed?

Condense roles/permissions/auth docs and align them with the code
Condense membership, onboarding and import docs and align them with the code
Refresh, condense and align database and groups docs
Condense and translate email, UI and PDF docs to English
Condense progress log, roadmap and test/infra docs
Add a documentation index and fix dangling references

Definition of Done

Code Quality

No new technical depths
Linting passed
Documentation is added were needed

Accessibility

New elements are properly defined with html-tags
Colour contrast follows WCAG criteria
Aria labels are added when needed
Everything is accessible by keyboard
Tab-Order is comprehensible
All interactive elements have a visible focus

Testing

Tests for new code are written
All tests pass
axe-core dev tools show no critical or major issues

Additional Notes

Documentation-only change; ran intentionally without CI/tests (no application code behavior changed). The only non-doc edits are a comment link in test/seeds_test.exs and a link in DESIGN_GUIDELINES.md.
docs/ shrank from ~583 KB to ~285 KB (29 → 28 files); 2 spent process artifacts removed after extracting their unique content.
A consistency pass corrected pre-existing doc↔code drift (e.g. fictional member-linking actions, wrong routes, stale schema facts) and replaced drift-prone code excerpts / version pins / line-number citations with references to the source module, toward a single source of truth.
Large diffs expected: most commits delete substantially more than they add (verbose/spent content removed); the schema DBML grew (stale tables/columns added back).

## Description of the implemented changes The changes were: - [ ] Bugfixing - [ ] New Feature - [ ] Breaking Change - [x] Refactoring Cleanup of the `/docs` directory: many docs had accumulated during development. They were condensed for readability, brought back in sync with the code, and given an index, while preserving all load-bearing information. No application code behavior changes. ## What has been changed? - Condense roles/permissions/auth docs and align them with the code - Condense membership, onboarding and import docs and align them with the code - Refresh, condense and align database and groups docs - Condense and translate email, UI and PDF docs to English - Condense progress log, roadmap and test/infra docs - Add a documentation index and fix dangling references ## Definition of Done ### Code Quality - [ ] No new technical depths - [ ] Linting passed - [x] Documentation is added were needed ### Accessibility - [ ] New elements are properly defined with html-tags - [ ] Colour contrast follows WCAG criteria - [ ] Aria labels are added when needed - [ ] Everything is accessible by keyboard - [ ] Tab-Order is comprehensible - [ ] All interactive elements have a visible focus ### Testing - [ ] Tests for new code are written - [ ] All tests pass - [ ] axe-core dev tools show no critical or major issues ## Additional Notes - Documentation-only change; ran intentionally without CI/tests (no application code behavior changed). The only non-doc edits are a comment link in `test/seeds_test.exs` and a link in `DESIGN_GUIDELINES.md`. - `docs/` shrank from ~583 KB to ~285 KB (29 → 28 files); 2 spent process artifacts removed after extracting their unique content. - A consistency pass corrected pre-existing doc↔code drift (e.g. fictional member-linking actions, wrong routes, stale schema facts) and replaced drift-prone code excerpts / version pins / line-number citations with references to the source module, toward a single source of truth. - Large diffs expected: most commits delete substantially more than they add (verbose/spent content removed); the schema DBML grew (stale tables/columns added back).

moritz added 6 commits 2026-06-15 22:00:15 +02:00