This directory contains project documentation for day-to-day development, tooling, workflows, and maintenance tasks.
Use the main README.md for project setup and onboarding.
Use the documents below when you need more detailed guidance about a specific
topic.
Table of Contents ᐞ
Available documents ᐞ
- AI-assisted change policy - repository-level guidance for AI-assisted changes and how those rules align with CI, contributor workflow, and project conventions.
- Custom commands - common
makeandyarncommands used in development. - GitHub Actions update guide - maintenance workflow for SHA-pinned GitHub Actions and update checks.
- Concepts and features - overview of the application architecture and notable features.
- Dependency update - dependency upgrade workflow and notes.
- Dev Containers - opening and working with this project in Dev Container capable IDEs.
- Speed problems with application? - tips for improving Docker-based development performance.
- Tools - project tooling overview.
- Translations - translation workflow and i18n notes.
- Usage checklist - a short checklist for common usage scenarios.
- Yarn version management - full guide for checking and upgrading the pinned Yarn version.
- Yarn update quick reference - condensed command cheatsheet for Yarn version checks and upgrades.
Quick navigation ᐞ
For the most common starting points:
- New contributor setup:
../README.md - AI-assisted change policy:
AI_RULES.md - Day-to-day commands:
COMMANDS.md - Yarn version workflow:
YARN_UPDATE_QUICK_REF.md - GitHub Actions pin maintenance:
ACTIONS_UPDATE.md - Dev Container usage:
DEV_CONTAINERS.md - Translation workflow:
TRANSLATIONS.md