Skip to content

Commit d572ef7

Browse files
emjay0921emjay0921
committed
docs: add proper DESCRIPTION.md for 7 modules missing detailed descriptions
1 parent 1189ce8 commit d572ef7

12 files changed

Lines changed: 1242 additions & 7 deletions

File tree

‎spp_dci_demo/README.rst‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
================
2+
OpenSPP DCI Demo
3+
================
4+
5+
..
6+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7+
!! This file is generated by oca-gen-addon-readme !!
8+
!! changes will be overwritten. !!
9+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10+
!! source digest: sha256:55e3de346d907f545cb31b41597be40831792981e13bd61244e4f40809d2d57d
11+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
12+
13+
.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
14+
:target: https://odoo-community.org/page/development-status
15+
:alt: Alpha
16+
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
17+
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
18+
:alt: License: LGPL-3
19+
.. |badge3| image:: https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github
20+
:target: https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_dci_demo
21+
:alt: OpenSPP/OpenSPP2
22+
23+
|badge1| |badge2| |badge3|
24+
25+
Demonstrates DCI (Digital Civil Infrastructure) birth verification
26+
integration for child benefit enrollment. Extends the change request
27+
workflow to verify newborn identity against CRVS (Civil Registration and
28+
Vital Statistics) registries before adding members to households.
29+
30+
Key Features
31+
~~~~~~~~~~~~
32+
33+
- Birth verification via DCI data sources (BRN lookup, data match
34+
validation)
35+
- Verification status tracking (unverified, verified, not_found, error)
36+
- HTML-formatted verification summary badges on change request forms
37+
- Proxy response flagging for child assessments
38+
- Audit trail of verification requests and responses
39+
- Demo household data for testing DCI integration workflows
40+
41+
.. IMPORTANT::
42+
This is an alpha version, the data model and design can change at any time without warning.
43+
Only for development or testing purpose, do not use in production.
44+
45+
**Table of contents**
46+
47+
.. contents::
48+
:local:
49+
50+
Changelog
51+
=========
52+
53+
19.0.2.0.0
54+
~~~~~~~~~~
55+
56+
- Initial migration to OpenSPP2
57+
58+
Bug Tracker
59+
===========
60+
61+
Bugs are tracked on `GitHub Issues <https://github.com/OpenSPP/OpenSPP2/issues>`_.
62+
In case of trouble, please check there if your issue has already been reported.
63+
If you spotted it first, help us to smash it by providing a detailed and welcomed
64+
`feedback <https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20spp_dci_demo%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
65+
66+
Do not contact contributors directly about support or help with technical issues.
67+
68+
Credits
69+
=======
70+
71+
Authors
72+
-------
73+
74+
* OpenSPP.org
75+
76+
Maintainers
77+
-----------
78+
79+
.. |maintainer-jeremi| image:: https://github.com/jeremi.png?size=40px
80+
:target: https://github.com/jeremi
81+
:alt: jeremi
82+
.. |maintainer-gonzalesedwin1123| image:: https://github.com/gonzalesedwin1123.png?size=40px
83+
:target: https://github.com/gonzalesedwin1123
84+
:alt: gonzalesedwin1123
85+
86+
Current maintainers:
87+
88+
|maintainer-jeremi| |maintainer-gonzalesedwin1123|
89+
90+
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_dci_demo>`_ project on GitHub.
91+
92+
You are welcome to contribute.

‎spp_dci_demo/readme/DESCRIPTION.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,10 @@
1-
DCI Demo: Birth Verification for Child Benefit Enrollment
1+
Demonstrates DCI (Digital Civil Infrastructure) birth verification integration for child benefit enrollment. Extends the change request workflow to verify newborn identity against CRVS (Civil Registration and Vital Statistics) registries before adding members to households.
2+
3+
### Key Features
4+
5+
- Birth verification via DCI data sources (BRN lookup, data match validation)
6+
- Verification status tracking (unverified, verified, not_found, error)
7+
- HTML-formatted verification summary badges on change request forms
8+
- Proxy response flagging for child assessments
9+
- Audit trail of verification requests and responses
10+
- Demo household data for testing DCI integration workflows

‎spp_disability_registry/README.rst‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
===========================
2+
OpenSPP Disability Registry
3+
===========================
4+
5+
..
6+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7+
!! This file is generated by oca-gen-addon-readme !!
8+
!! changes will be overwritten. !!
9+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10+
!! source digest: sha256:force_regen
11+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
12+
13+
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
14+
:target: https://odoo-community.org/page/development-status
15+
:alt: Beta
16+
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
17+
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
18+
:alt: License: LGPL-3
19+
.. |badge3| image:: https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github
20+
:target: https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_disability_registry
21+
:alt: OpenSPP/OpenSPP2
22+
23+
|badge1| |badge2| |badge3|
24+
25+
Comprehensive disability assessment and registry management for social
26+
protection programs. Implements the Washington Group Short Set (WG-SS)
27+
and UNICEF Child Functioning Module (CFM) standards with ICF alignment
28+
for standardized disability identification.
29+
30+
Key Features
31+
~~~~~~~~~~~~
32+
33+
- Washington Group 6-domain assessment (seeing, hearing, walking,
34+
remembering, self-care, communicating)
35+
- Age-based assessment types: WG-SS (adults 18+), CFM 5-17, CFM 2-4 with
36+
automatic detection
37+
- Disability indicator computation per WG standard (any domain with "a
38+
lot of difficulty" or "cannot do at all")
39+
- Review category system (MIE/MIP/MINE) with automatic next-review-date
40+
scheduling
41+
- Impairment type, cause, and severity classifications using DCI
42+
vocabularies
43+
- Assistive device management with status workflow (needed, requested,
44+
provided)
45+
- Proxy response tracking for children
46+
- CEL function integration for program eligibility targeting
47+
48+
**Table of contents**
49+
50+
.. contents::
51+
:local:
52+
53+
Changelog
54+
=========
55+
56+
19.0.2.0.0
57+
~~~~~~~~~~
58+
59+
- Initial migration to OpenSPP2
60+
61+
Bug Tracker
62+
===========
63+
64+
Bugs are tracked on `GitHub Issues <https://github.com/OpenSPP/OpenSPP2/issues>`_.
65+
In case of trouble, please check there if your issue has already been reported.
66+
If you spotted it first, help us to smash it by providing a detailed and welcomed
67+
`feedback <https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20spp_disability_registry%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
68+
69+
Do not contact contributors directly about support or help with technical issues.
70+
71+
Credits
72+
=======
73+
74+
Authors
75+
-------
76+
77+
* OpenSPP.org
78+
79+
Maintainers
80+
-----------
81+
82+
.. |maintainer-jeremi| image:: https://github.com/jeremi.png?size=40px
83+
:target: https://github.com/jeremi
84+
:alt: jeremi
85+
.. |maintainer-gonzalesedwin1123| image:: https://github.com/gonzalesedwin1123.png?size=40px
86+
:target: https://github.com/gonzalesedwin1123
87+
:alt: gonzalesedwin1123
88+
.. |maintainer-emjay0921| image:: https://github.com/emjay0921.png?size=40px
89+
:target: https://github.com/emjay0921
90+
:alt: emjay0921
91+
92+
Current maintainers:
93+
94+
|maintainer-jeremi| |maintainer-gonzalesedwin1123| |maintainer-emjay0921|
95+
96+
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_disability_registry>`_ project on GitHub.
97+
98+
You are welcome to contribute.

‎spp_disability_registry/readme/DESCRIPTION.md‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,12 @@
1-
Disability assessment and registry management for social protection
1+
Comprehensive disability assessment and registry management for social protection programs. Implements the Washington Group Short Set (WG-SS) and UNICEF Child Functioning Module (CFM) standards with ICF alignment for standardized disability identification.
2+
3+
### Key Features
4+
5+
- Washington Group 6-domain assessment (seeing, hearing, walking, remembering, self-care, communicating)
6+
- Age-based assessment types: WG-SS (adults 18+), CFM 5-17, CFM 2-4 with automatic detection
7+
- Disability indicator computation per WG standard (any domain with "a lot of difficulty" or "cannot do at all")
8+
- Review category system (MIE/MIP/MINE) with automatic next-review-date scheduling
9+
- Impairment type, cause, and severity classifications using DCI vocabularies
10+
- Assistive device management with status workflow (needed, requested, provided)
11+
- Proxy response tracking for children
12+
- CEL function integration for program eligibility targeting

0 commit comments

Comments
 (0)