Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Expose DMN rule documentation and policy sources in the builder

Đang mở
  • Có gì không ổn?
#563 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
java, python
Lĩnh vực
backend-api-design, documentation, full-stack

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Java
Star
16
Fork
5
Merge trung bình
14 giờ 34 phút
Pull request đã merge (30 ngày)
23

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của CodeForPhilly/benefit-decision-toolkit

Tất cả issue của CodeForPhilly/benefit-decision-toolkit

Issue tương tự

Thêm issue về Java

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.