Skip to content

Commit 02c1af8

Browse files
committed
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
1 parent 64a6261 commit 02c1af8

4 files changed

Lines changed: 114 additions & 22 deletions

File tree

docs/overview/concepts/index.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,38 @@ review-status: reviewed
33
review-date: 2025-09-01
44
reviewer: Mark Penalosa
55
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"
611
---
712

813
# Concepts
914

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.
1116

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
1318

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
1520

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 components of an IBR, its advantages, and its relationship with social registries
1722

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 architecture and inheritance
1924

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
2126

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
2328

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
2530

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
2732

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
2938

3039
```{toctree}
3140
---

docs/overview/features/index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,16 @@ review-status: needs-review
33
review-date: 2025-06-04
44
reviewer: migration-script
55
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"
611
---
712

813
# Features
914

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.
1116

1217
## Data Foundation
1318

docs/overview/index.md

Lines changed: 76 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,88 @@ review-status: needs-review
33
review-date: 2025-06-04
44
reviewer: migration-script
55
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"
611
---
712

813
# Overview
914

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.
1116

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
1718

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.
29+
::::
30+
31+
::::{grid-item-card} [Social Registry](products/social_registry.md)
32+
:link: products/social_registry.md
33+
:link-type: doc
34+
35+
Centralized beneficiary database that serves as a single source of truth across multiple programs, reducing duplication and enabling better coordination.
36+
::::
37+
38+
::::{grid-item-card} [Farmer Registry](products/farmer_registry.md)
39+
:link: products/farmer_registry.md
40+
:link-type: doc
41+
42+
Agricultural-focused platform combining farm data, land management, and social protection for rural development and climate resilience programs.
43+
::::
44+
:::::
45+
46+
[Explore all products →](products/index.md)
47+
48+
## Understand core capabilities
49+
50+
OpenSPP delivers comprehensive social protection through modular features that work together seamlessly:
51+
52+
**Data Foundation**
53+
- [Unified registry](features/unified_registry.md) for consolidated beneficiary data
54+
- [GIS and land management](features/gis_land_management.md) for location-based targeting
55+
56+
**Program Delivery**
57+
- [Program management](features/program_management.md) across the complete lifecycle
58+
- [Eligibility and targeting](features/eligibility_targeting.md) with flexible rules
59+
- [Payment and disbursement](features/payment_disbursement.md) through multiple channels
60+
61+
**System Infrastructure**
62+
- [Data integration and APIs](features/data_integration_apis.md) for interoperability
63+
- [Change management](features/change_management.md) with audit trails
64+
- [Grievance redress](features/grievance_redress.md) for accountability
65+
66+
[View all features →](features/index.md)
67+
68+
## Learn fundamental concepts
69+
70+
Understanding OpenSPP's design principles and theoretical foundations:
71+
72+
- [Digital public infrastructure](concepts/digital_public_infrastructure.md) - How OpenSPP aligns with DPI principles
73+
- [Integrated beneficiary registry](concepts/integrated_beneficiary_registry.md) - Registry architecture and design
74+
- [Data protection](concepts/data_protection.md) - Privacy and security framework
75+
- [Extensibility](concepts/extensibility.md) - Platform customization capabilities
76+
77+
[Explore all concepts →](concepts/index.md)
78+
79+
## Plan your implementation
80+
81+
Ready to explore OpenSPP for your organization? Our structured approach helps you validate fit and plan successful deployments:
82+
83+
**[From proof of concept to pilot](poc_and_pilot.md)** - Comprehensive guide covering:
84+
- Proof of concept (4-8 weeks) for initial validation
85+
- Pilot implementation (3-6 months) for real-world testing
86+
- Resource planning and success criteria
87+
- Prerequisites and decision frameworks
1888

1989
```{toctree}
2090
:maxdepth: 2

docs/overview/products/index.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,27 @@ review-status: needs-review
33
review-date: 2025-06-04
44
reviewer: migration-script
55
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"
611
---
712

813
# Products
914

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.
1116

12-
Within this section, you will find detailed information of the following products.
17+
## Available configurations
1318

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.
1521

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.
1724

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.
1927

2028

2129
```{toctree}

0 commit comments

Comments
 (0)