halkyon-days/halkyon
Watch
1
0
Fork
You've already forked halkyon
 0
Code Issues Pull requests Projects Releases 37 Packages Wiki Activity Actions

docs: one repository for every app and shared package (ADR 0015)

Browse source 
The root AGENTS.md holds what applies to every app and package (how
work is done, Serverpod, checks with Melos and the tools, CI); Learn's
own is apps/learn/AGENTS.md, Todo's a note that it is still the
scaffold. The root README introduces the project, Learn's moves to its
folder; LICENSE.md says which licence covers which directory, Todo's
packages unlicensed until decided; one CONTRIBUTING.md. ADR 0015
records the decision; ADR 0014 and 0003 note what moved.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Tizian 「ティツィアーン」 <raisondetredev@pm.me>
This commit is contained in:
Tizian 「ティツィアーン」 2026-10-19 20:39:09 +02:00
commit 1b62c8098c
Signed by: raisondetredev
GPG key ID: 07F6FCF405488B64
1 changed files with 542 additions and 393 deletions
Download patch file Download diff file Expand all files Collapse all files

12
packages/halkyon_app/README.md
View file

@ -28,7 +28,7 @@ Written as the apps are: Dart 3.13's primary constructors, Material from
have their own, such as Scotland; else the country's). Countries are named
by the app's `CountryNames`, subdivisions by Unicode CLDR's names in English
and German, which come with the package (`AssetSubdivisionNames`; the
workspace's `tool/subdivision_names.py` writes them).
package's `tool/subdivision_names.py` writes them).
- **Gates** (`lib/src/app/`): `InstanceGate` opens the app's dependencies on
the instance in use (`AppDependencies`, handed down by `AppScope`), anew on
a switch, the previous ones closed first; `SessionGate` keeps a person
@ -57,17 +57,13 @@ Written as the apps are: Dart 3.13's primary constructors, Material from
1. **The server** includes `halkyon_base` with the nickname `base` (its
README), so the app's generated client has `client.modules.base`.
2. **Depend on it** by git, pinned to a signed commit of halkyon_shared's
main, as `halkyon_ui` (whose README shows the `pubspec_overrides.yaml` for
working on both at once):
2. **Depend on it** by path, within the repository's workspace, as on
`halkyon_ui`:
```yaml
dependencies:
halkyon_app:
git:
url: https://code.halkyon.app/project-halkyon/halkyon_shared.git
path: packages/halkyon_app
ref: <signed commit>
path: ../../../packages/halkyon_app
```
3. **Texts**: add `HalkyonAppLocalizations.delegate` to every `MaterialApp`'s