DaTe Website Documentation
This directory is published via a GitHub Pages workflow. Push a change under docs/ to the main branch and the public documentation site refreshes automatically.
Use the sections below to jump to either editor-facing instructions or implementation notes.
Start Here
- Working on local setup, Docker, migrations, translations, or deployments? Start with the repository root
README.md.
- Editing content in Django admin? Use the
Admin & Content Editors guides below.
- Changing code, templates, models, or routing? Use the
Developers guides below.
- Adding a new app or major feature? Update both the relevant app guide and this index so the published docs stay navigable.
Project-wide Notes
- The project can run multiple association/site variants via
PROJECT_NAME.
- Language switching and multilingual content are controlled by
ENABLE_LANGUAGE_FEATURES.
- The Django admin theme is controlled by
USE_UNFOLD; false uses classic admin, true enables Unfold.
- The public docs are meant to complement the README, not replace it. Keep operational commands in the README and app-specific behavior in these guides.
Admin & Content Editors
Developers
Maintenance
- Try to keep app guides focused on responsibilities, data model expectations, important admin behavior, and extension gotchas.
- When routing, language handling, or deployment behavior changes, it usually helps to update the README and any affected development guide in the same branch.
- If a guide becomes mostly obsolete, a rewrite is usually clearer than layering more historical notes on top.
Need to add or update a guide? Create or edit the Markdown file in the appropriate subfolder, then commit and push to main. GitHub Pages redeploys when docs/ changes.