Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Expose DMN rule documentation and policy sources in the builder

Aperta
  • Qualcosa non va?
#563 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
java, python
Ambito
backend-api-design, documentation, full-stack

Direzione di ricerca

Start with .agents/skills/references/dmn-documentation.md, existing documented DMN models, and bin/library/load-library-metadata.py; trace how ModelRegistry extracts model descriptions and how builder-api stores and refreshes library metadata. Then follow the frontend library benefit/check views. Done means documentation and named sources reach the author details view with provenance, safe text rendering, older-metadata handling, and the specified round-trip, refresh, and frontend tests.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Library benefits and checks now carry their rule documentation in DMN descriptions, KIE documentation links (kie:attachment), shared type/BKM descriptions, and selective diagram text annotations. The builder currently receives model summaries and input/composition metadata, but authors cannot inspect the detailed rules, policy sources, review/effective dates, or known limitations without opening the DMN files.

Expose this documentation in the builder using the DMN as the source of truth. For example, an author selecting PECO CAP should be able to read why re-entry requires provider approval and open the cited handbook/order. Senior Citizen Tax Freeze should visibly disclose that its current model omits the program's income check.

Scope

  • Extend library discovery/OpenAPI metadata to represent model and decision documentation, named source links, and relevant annotations. Include descriptions for parameters and shared input types/fields, with references to their owning model/element rather than copying a separate policy document into every benefit.
  • Carry this metadata through bin/library/load-library-metadata.py, builder-api library metadata storage/refresh, and frontend library benefit/check views.
  • Provide a readable documentation/details view when choosing or reviewing library benefits and checks. Show rule interpretation, boundaries and unknown-input behavior, policy review/effective dates when present, named clickable sources, and implementation limitations.
  • Preserve provenance (model path, element ID, library version) so imported benefits/checks can identify their documentation source. Define refresh behavior and handle older metadata that lacks documentation.
  • Render descriptions as text and support the named documentation URLs without treating arbitrary DMN text as executable HTML.

Implementation notes

  • DMN 1.6 uses dmn:description; KIE Tools 10.2 links use dmn:extensionElements/kie:attachment with name and url. Notes use standard dmn:textAnnotation and optional associations to the relevant node.
  • ModelRegistry currently extracts only the model description. Inspect the original DMN XML for KIE extensions: the default Java engine marshaller skips extension children without registered converters, so extracting only the compiled runtime model can lose source links. The KIE Tools 10.2 editor marshaller preserves them.
  • Keep this read-only author documentation separate from executable decisions, applicant answers and eligibility results. Do not introduce an evaluated documentation decision.
  • The repository convention is .agents/skills/references/dmn-documentation.md; use existing documented models as fixtures, including shared fields and associated annotations.

Acceptance criteria

  • Benefit/check details show their DMN documentation and named policy sources without manually maintained duplicate content.
  • Shared input/parameter explanations are reachable from the relevant author workflow, with provenance intact.
  • Important caveats remain discoverable, including PECO CAP provider review and the current Senior Citizen Tax Freeze income gap.
  • Metadata round-trip/refresh tests cover root and decision links, shared type descriptions, associated annotations and models with no documentation.
  • Frontend tests cover readable details, source links, missing metadata and refresh behavior.

Related: #341 (library-check documentation), #549 (utility benefit models). This is distinct from #553/#554: those introduce applicant-facing application/help next steps and copy them into screeners; this issue exposes model/rule documentation for screener authors.

Lingua principale
Java
Stelle
16
Fork
5
Merge medio
14h 34m
PR unite (30g)
23

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di CodeForPhilly/benefit-decision-toolkit

Tutte le issue di CodeForPhilly/benefit-decision-toolkit

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.