Skip to content

Commit 17b415f

Browse files
committed
Update prompts
1 parent 7248594 commit 17b415f

File tree

6 files changed

+20
-3
lines changed

6 files changed

+20
-3
lines changed

GLOSSARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
Use this file as the host index; topic glossaries override root definitions. Follow Glossary Precedence Policy: topic glossaries > root terms; duplicate only enforced prompt-language mappings.
44

55
## Topic Glossaries
6+
- JWebMP Typescript Client (canonical): `rules/generative/frontend/jwebmp/typescript/GLOSSARY.md`
67
- Enterprise base: `rules/GLOSSARY.md`
78
- Java 25/Maven: `rules/generative/language/java/java-25.rules.md`
89
- TypeScript/Angular: `rules/generative/language/typescript/GLOSSARY.md`, `rules/generative/language/angular/GLOSSARY.md`, override: `rules/generative/language/angular/angular-20.rules.md`

PROMPT_ADOPT_EXISTING_PROJECT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ Fill before running.
171171
- Angular (choose exactly one)
172172
- [ ] Angular 17
173173
- [ ] Angular 19
174-
- [X] Angular 20
174+
- [ ] Angular 20
175175
- Other frameworks
176176
- [ ] React
177177
- [ ] Next.js

PROMPT_LIBRARY_RULES_UPDATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Fill before running.
157157
- Angular (choose exactly one)
158158
- [ ] Angular 17
159159
- [ ] Angular 19
160-
- [x] Angular 20
160+
- [ ] Angular 20
161161
- Other frameworks
162162
- [ ] React
163163
- [ ] Next.js

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ A Maven Java 25 library that exposes Ng* annotations and helpers so JWebMP compo
1010
- Architecture diagrams: `docs/architecture/README.md`
1111
- Prompt reference for future runs: `docs/PROMPT_REFERENCE.md`
1212

13+
## How to use these rules
14+
- Library rules index: `rules/generative/frontend/jwebmp/typescript/README.md` (annotations, scanning/runtime, configuration/rendering, testing, CI/release).
15+
- Follow stage gates: Stage 1–3 are documentation; Stage 4 (implementation) is allowed because blanket approval is recorded in `PACT.md`.
16+
- Keep host docs outside `rules/`; reference diagrams under `docs/architecture/` and topic glossary under `rules/generative/frontend/jwebmp/typescript/GLOSSARY.md`.
17+
- Generated TypeScript is read-only; change Java annotations/configuration and rerun the generator instead of editing outputs.
18+
19+
## Prompt language alignment & glossary
20+
- Canonical topic glossary: `rules/generative/frontend/jwebmp/typescript/GLOSSARY.md` (Ng* metadata, CRTP fluency, LLM guidance).
21+
- Root glossary router: `GLOSSARY.md` links to enterprise glossaries (`rules/`) and the topic glossary above. Host projects should copy only enforced prompt-language mappings and link back for everything else.
22+
1323
## Rules Repository
1424
- The enterprise rules live in the `rules/` submodule (`.gitmodules` already configured). Keep host project docs outside that directory.
1525
- Follow behavioral/technical/forward-only/modularity guidance from `rules/RULES.md` plus stack-specific rule links in `RULES.md`.

docs/PROMPT_REFERENCE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ Load this file before future AI runs. It captures selected stacks, glossary rout
2222
- Context: `docs/architecture/c4-context.md`
2323
- Container: `docs/architecture/c4-container.md`
2424
- Component (Angular metadata pipeline): `docs/architecture/c4-component-angular-metadata.md`
25+
- Dependency map: `rules/generative/frontend/jwebmp/typescript/dependency-map.md`
2526
- Sequences: `docs/architecture/sequence-startup-scan.md`, `docs/architecture/sequence-component-config.md`
2627
- ERD: `docs/architecture/erd-angular-metadata.md`
2728

2829
## Policies
2930
- Forward-only; documentation-first stage gates recorded (blanket approval active for this run).
3031
- Host docs stay outside `rules/` submodule.
32+
- Glossary composition (topic-first): root `GLOSSARY.md` links to topic glossaries; library topic glossary lives at `rules/generative/frontend/jwebmp/typescript/GLOSSARY.md` and should remain canonical for Ng* metadata terms and LLM alignment.

docs/architecture/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@ All diagrams are text-first (Mermaid) and map to observed code in this repositor
88
- Sequence — startup scan: `docs/architecture/sequence-startup-scan.md`
99
- Sequence — component config build: `docs/architecture/sequence-component-config.md`
1010
- ERD — annotation to configuration: `docs/architecture/erd-angular-metadata.md`
11+
- Dependency map (trusted boundaries and external stacks): `rules/generative/frontend/jwebmp/typescript/dependency-map.md`
1112

12-
Trust boundary (observed): Host app inputs (annotated components) cross into this library’s scan/render pipeline; Guice/Vert.x execution is trusted infrastructure; generated TypeScript is consumed by downstream builds and should not execute unvalidated runtime inputs.
13+
Trust boundary (observed)
14+
- Inputs: annotated host classes. Processing happens inside trusted library/Guice/Vert.x workers using ClassGraph.
15+
- Outputs: generated TypeScript is a build artifact for the Angular toolchain; do not treat it as runtime input.
16+
- Logging: Log4j2 inside the library; no external network calls are present.
1317

1418
These diagrams are referenced by PACT/GLOSSARY/RULES/GUIDES/IMPLEMENTATION for traceability.

0 commit comments

Comments
 (0)