You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: improve overview section with better structure and metadata
- Add myst frontmatter with html_meta to all overview pages
- Rewrite introductions to be direct and useful
- Organize concepts by themes (architecture, data, security)
- Improve product configuration descriptions
- Follow contributor guidelines for sentence case and linking
- Remove corporate language in favor of clear explanations
Copy file name to clipboardExpand all lines: docs/overview/concepts/index.md
+19-10Lines changed: 19 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,29 +3,38 @@ review-status: reviewed
3
3
review-date: 2025-09-01
4
4
reviewer: Mark Penalosa
5
5
migration-notes: "Added during 2025 documentation reorganization"
6
+
myst:
7
+
html_meta:
8
+
"title": "OpenSPP Core Concepts"
9
+
"description": "Core concepts and theoretical foundations of OpenSPP social protection platform"
10
+
"keywords": "OpenSPP, concepts, digital public infrastructure, data protection, registry"
6
11
---
7
12
8
13
# Concepts
9
14
10
-
This section is dedicated to exploring the core concepts and theoretical foundations of OpenSPP platform. Unlike reference materials that focus on specific functionalities, this documentation provides a higher-level understanding of the principles and philosophies guiding OpenSPP's design and implementation.
15
+
These concepts explain the theoretical foundations and design principles behind OpenSPP. Understanding them helps you make better decisions about implementation and customization.
11
16
12
-
- {doc}`data_collection_validation`: This document outlines OpenSPP's approach to data, emphasizing data minimization, user consent, and versatile input methods. It also covers the platform's validation processes, including input validation, data integrity checks, and a mix of automated and manual validation.
17
+
## Architecture and design
13
18
14
-
-{doc}`data_protection`: This document details the principles of data protection within the context of Digital Public Infrastructure. It covers key concepts like lawfulness, data minimization, and accountability, and provides measures for implementing strong data protection.
19
+
-**[Digital public infrastructure](digital_public_infrastructure.md)** - Essential components of DPI and how OpenSPP aligns with DPI principles through modular, interoperable architecture
15
20
16
-
-{doc}`digital_public_infrastructure`: This document introduces the concept of Digital Public Infrastructure (DPI) and its essential components. It explains the role of DPI in social protection and how OpenSPP aligns with DPI principles through its modular and interoperable architecture.
21
+
-**[Integrated beneficiary registry](integrated_beneficiary_registry.md)** - Key componentsof an IBR, its advantages, and its relationship with social registries
17
22
18
-
-{doc}`extensibility`: This document explains how OpenSPP's foundation on the Odoo framework makes it a highly customizable, configurable, and extensible platform. It covers concepts like modular architecture, inheritance, and the use of a large ecosystem of pre-built modules.
23
+
-**[Extensibility](extensibility.md)** - How OpenSPP's Odoo foundation enables customization through modular architectureand inheritance
19
24
20
-
- {doc}`integrated_beneficiary_registry`: This document defines the Integrated Beneficiary Registry (IBR) and explains its role in social protection. It details the key components of an IBR, its advantages, and its relationship with a social registry.
25
+
## Data management
21
26
22
-
-{doc}`registrant_concepts`: This document introduces the key terminology related to registrants in OpenSPP. It defines what a registrant is and explains the core concepts of individuals, groups, group memberships, and their relationships within the system.
27
+
-**[Registry key concepts](registry_key_concepts.md)** - Best practices for organizing data with a minimalistic approach and the four main registry structure components
23
28
24
-
-{doc}`registry_key_concepts`: This document outlines the best practices for organizing data within the OpenSPP registry, emphasizing a minimalistic approach. It provides guidance on where to store different types of data and introduces the four main components of the registry's structure.
29
+
-**[Registrant concepts](registrant_concepts.md)** - Core terminology for individuals, groups, group memberships, and their relationships
25
30
26
-
-{doc}`user_management`: This document describes the user management framework in OpenSPP, which is designed to safeguard user data and control access to system features. It covers the two main approaches to user management and outlines best practices for ensuring security and efficiency.
31
+
-**[Data collection and validation](data_collection_validation.md)** - Data minimization, user consent, versatile input methods, and validation processes
27
32
28
-
By delving into these concepts, you will gain a deeper appreciation for how OpenSPP works, enabling you to make more informed decisions when configuring and utilizing the platform for your specific needs.
33
+
## Security and governance
34
+
35
+
-**[Data protection](data_protection.md)** - Principles of lawfulness, data minimization, and accountability within DPI context
36
+
37
+
-**[User management](user_management.md)** - Framework for controlling system access and safeguarding user data with two management approaches
Copy file name to clipboardExpand all lines: docs/overview/features/index.md
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,11 +3,16 @@ review-status: needs-review
3
3
review-date: 2025-06-04
4
4
reviewer: migration-script
5
5
migration-notes: "Added during 2025 documentation reorganization"
6
+
myst:
7
+
html_meta:
8
+
"title": "OpenSPP Features"
9
+
"description": "Comprehensive features of OpenSPP social protection platform including registry, program management, and payment systems"
10
+
"keywords": "OpenSPP, features, social protection, registry, eligibility, payments, GIS"
6
11
---
7
12
8
13
# Features
9
14
10
-
OpenSPP delivers comprehensive social protection capabilities through modular, interoperable components that adapt to diverse program requirements and implementation contexts. Each feature area integrates seamlessly with others, creating a unified platform for managing complex social protection interventions.
15
+
OpenSPP's features work together to deliver end-to-end social protection programs. Each component can be configured independently while maintaining seamless integration with others.
Copy file name to clipboardExpand all lines: docs/overview/index.md
+76-6Lines changed: 76 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,18 +3,88 @@ review-status: needs-review
3
3
review-date: 2025-06-04
4
4
reviewer: migration-script
5
5
migration-notes: "Added during 2025 documentation reorganization"
6
+
myst:
7
+
html_meta:
8
+
"title": "OpenSPP Overview"
9
+
"description": "High-level overview of OpenSPP social protection platform products, features, and concepts for decision makers"
10
+
"keywords": "OpenSPP, overview, social protection, SP-MIS, Social Registry, Farmer Registry"
6
11
---
7
12
8
13
# Overview
9
14
10
-
Welcome to the OpenSPP overview section. This section provides high-level information about OpenSPP's features, concepts, and product configurations for decision makers and new users.
15
+
OpenSPP is a modular platform for delivering social protection programs. This section explains what it does, how it works, and whether it fits your needs.
11
16
12
-
- {doc}`products/index`
13
-
- {doc}`features/index`
14
-
- {doc}`concepts/index`
15
-
- {doc}`poc_and_pilot`
16
-
<!-- - {doc}`case_studies/index` -->
17
+
## Choose your product configuration
17
18
19
+
OpenSPP offers three specialized configurations designed for different social protection scenarios:
20
+
21
+
:::::{grid} 3
22
+
:gutter: 2
23
+
24
+
::::{grid-item-card} [SP-MIS](products/sp_mis.md)
25
+
:link: products/sp_mis.md
26
+
:link-type: doc
27
+
28
+
Social Protection Management Information System for comprehensive program delivery including cash transfers, conditional assistance, and humanitarian interventions.
Centralized beneficiary database that serves as a single source of truth across multiple programs, reducing duplication and enabling better coordination.
Copy file name to clipboardExpand all lines: docs/overview/products/index.md
+13-5Lines changed: 13 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,19 +3,27 @@ review-status: needs-review
3
3
review-date: 2025-06-04
4
4
reviewer: migration-script
5
5
migration-notes: "Added during 2025 documentation reorganization"
6
+
myst:
7
+
html_meta:
8
+
"title": "OpenSPP Product Configurations"
9
+
"description": "OpenSPP product configurations - SP-MIS, Social Registry, and Farmer Registry for social protection programs"
10
+
"keywords": "OpenSPP, SP-MIS, Social Registry, Farmer Registry, social protection"
6
11
---
7
12
8
13
# Products
9
14
10
-
This section provides a comprehensive overview of OpenSPP's core product configurations. It is designed to guide you through the setup and customization of the platform's key components, ensuring they are tailored to meet the specific needs of your social protection programs.
15
+
OpenSPP offers three product configurations, each designed for specific social protection use cases. Choose the one that matches your program's needs.
11
16
12
-
Within this section, you will find detailed information of the following products.
17
+
## Available configurations
13
18
14
-
- {doc}`social_registry`: Manage a centralized database of individuals and households, which serves as the foundation for various social programs.
19
+
### [SP-MIS](sp_mis.md)
20
+
Social Protection Management Information System for running complete social programs. Manages the entire lifecycle from beneficiary enrollment through payment disbursement. Ideal for cash transfers, humanitarian aid, and social assistance programs.
15
21
16
-
- {doc}`farmer_registry` Discover the tools and techniques for establishing a dedicated registry for farmers, enabling targeted agricultural interventions and support.
22
+
### [Social Registry](social_registry.md)
23
+
Centralized database of individuals and households that serves multiple social programs. Provides a single source of truth across interventions, reducing duplication and improving coordination between programs.
17
24
18
-
- {doc}`sp_mis` Manage the entire lifecycle of social protection programs, from beneficiary enrollment to payment disbursement.
25
+
### [Farmer Registry](farmer_registry.md)
26
+
Specialized registry for agricultural programs that bridges farming and social protection. Enables targeted agricultural interventions, input distribution, and climate-smart agriculture support for rural communities.
0 commit comments