Improve text

Author: Celine Lewerentz

docs/developer_guide/api_usage/dci_api.md

@@ -11,15 +11,15 @@ OpenSPP provides a RESTful API that adheres to the Digital Convergence Initiativ
 
 ## Process
 
-### Authentication: Obtaining an Access Token
+### Authentication: Obtaining an access token
 
 The DCI API is secured using OAuth 2.0 with the Client Credentials grant type. Before making any data requests, your application must obtain a bearer token.
 
 - **Endpoint**: `/oauth2/client/token`
 - **Method**: `POST`
 - **Body**: `x-www-form-urlencoded` with `grant_type`, `client_id`, `client_secret`, `db_name`.
 
-**Example: Get Access Token**
+**Example: Get access token**
 
 ```python
 import requests
@@ -46,7 +46,7 @@ access_token = token_data.get("access_token")
 print("Access Token obtained successfully.")
 ```
 
-### Searching the Registry
+### Searching the registry
 
 Once authenticated, you can use the access token to perform a synchronous search on the registry.
 
@@ -57,7 +57,7 @@ Once authenticated, you can use the access token to perform a synchronous search
     - `Content-Type`: `application/json`
 - **Body**: A JSON object conforming to the DCI `sync/search` request specification.
 
-**Example: Search for an Individual**
+**Example: Search for an individual**
 
 ```python
 search_url = f"{url}/registry/sync/search"
@@ -121,7 +121,7 @@ else:
 ```
 
 
-### Setup and Configuration
+### Setup and configuration
 
 To use the DCI API, you must first configure a client in OpenSPP.
 
@@ -131,13 +131,13 @@ To use the DCI API, you must first configure a client in OpenSPP.
 4.  **Reveal Credentials**: A **Show** button will appear. Click it to reveal the `Client ID` and `Client Secret`.
 5.  **Important**: Copy these credentials immediately. For security, the **Show** button will disappear after you close the dialog, and you will not be able to retrieve the secret again.
 
-## Best Practices
+## Best practices
 
-1.  **Secure Credential Storage**: Never hard-code your `Client ID` or `Client Secret` in your application. Use environment variables or a secure secret management system.
-2.  **Token Management**: Access tokens are short-lived. Your application should handle token expiration and automatically request a new one when needed.
-3.  **Error Handling**: Implement robust error handling to manage different HTTP status codes and error responses from the API.
-4.  **Secure Connections**: Always use HTTPS for all API traffic to protect data in transit.
-5.  **Logging**: Log request `transaction_id`s and correlation IDs to help with troubleshooting and auditing.
+-  **Secure Credential Storage**: Never hard-code your `Client ID` or `Client Secret` in your application. Use environment variables or a secure secret management system.
+-  **Token Management**: Access tokens are short-lived. Your application should handle token expiration and automatically request a new one when needed.
+-  **Error Handling**: Implement robust error handling to manage different HTTP status codes and error responses from the API.
+-  **Secure Connections**: Always use HTTPS for all API traffic to protect data in transit.
+-  **Logging**: Log request `transaction_id`s and correlation IDs to help with troubleshooting and auditing.
 
 ## References
 

docs/developer_guide/api_usage/external_api_jsonrpc.md

@@ -17,7 +17,7 @@ OpenSPP exposes much of its data and functionality via JSON-RPC endpoints. You c
 **Endpoint:**  
 - `/jsonrpc` — All JSON-RPC calls (authentication and model methods)
 
-### JSON-RPC Payload Structure and Methods
+### JSON-RPC payload structure and methods
 
 All interactions with the OpenSPP JSON-RPC API use a standard payload structure. Each request is a JSON object with the following keys:
 
@@ -29,7 +29,7 @@ All interactions with the OpenSPP JSON-RPC API use a standard payload structure.
     - `args`: A list of arguments for the method.
 - `id`: A unique identifier for the request (integer or string).
 
-**Example Payload:**
+**Example payload:**
 ```python
 payload = {
     "jsonrpc": "2.0",
@@ -48,12 +48,12 @@ payload = {
 }
 ```
 
-**Common JSON-RPC Methods:**
+**Common JSON-RPC methods:**
 - `authenticate`: Used for logging in and obtaining a user ID.
 - `execute_kw`: Used for calling model methods (such as `create`, `write`, `unlink`, `search_read`).
 ---
 
-### Common Model Methods and Args
+### Common model methods and args
 
 When using the `"object"` service with the `"execute_kw"` method, you can call various model methods. Here are the most common:
 
@@ -121,7 +121,7 @@ Searches for records and reads their fields.
 ["res.partner", "search_read", [[["is_group", "=", False]]], {"fields": ["name", "reg_id"], "limit": 5}]
 ```
 
-**Domain Filters:**  
+**Domain filters:**  
 A domain is a list of conditions, each as a list: `[field, operator, value]`.  
 Example: `[["name", "=", "John Doe"]]`
 
@@ -132,6 +132,7 @@ Example: `[["name", "=", "John Doe"]]`
 
 **Result**
 Returns a dictionary of the search results.
+
 ---
 
 ### Authentication
@@ -163,9 +164,9 @@ if not uid:
 print("Authenticated UID:", uid)
 ```
 
-### Working with Individuals
+### Working with individuals
 
-**Gather The Fields**
+**Gather the fields**
 
 For this example we are going to use these fields:
 
@@ -177,7 +178,7 @@ For this example we are going to use these fields:
 - `is_registrant` (boolean, default=True)
 - `is_group` (boolean, default=False)
 
-**Example: Create an Individual**
+**Example: Create an individual**
 
 ```python
 # First, get a gender_id (e.g., for "Male")
@@ -247,9 +248,9 @@ updated = response["result"]
 print("Result:", updated)
 ```
 
-### Working with Groups
+### Working with groups
 
-**Gather The Fields**
+**Gather the fields**
 
 For this example we are going to use these fields:
 
@@ -259,7 +260,7 @@ For this example we are going to use these fields:
 - `is_group` (boolean, default=True)
 
 
-**Example: Create a Group**
+**Example: Create a group**
 
 ```python
 # Get a group kind (e.g., "Household")
@@ -326,9 +327,9 @@ updated = response["result"]
 print("Result:", updated)
 ```
 
-### Working with Memberships
+### Working withmMemberships
 
-**Gather The Fields**
+**Gather the fields**
 
 From your `g2p_registry_membership` module, the main model is likely `g2p_registry_membership.group_membership`. Required fields typically include:
 - `individuak` (many2one, required)
@@ -337,7 +338,7 @@ From your `g2p_registry_membership` module, the main model is likely `g2p_regist
 - `start_date` (date, required)
 - Any other required fields as defined in your model
 
-**Example: Add an Individual to a Group**
+**Example: Add an individual to a group**
 
 ```python
 # Get a membership kind (e.g., "Head")
@@ -384,19 +385,19 @@ membership_id = response["result"]
 print("Created Membership ID:", membership_id)
 ```
 
-### Security: Using API Keys
+### Security: Using API keys
 
 - **API keys** are recommended over passwords for scripts and integrations.
 - Generate API keys in your OpenSPP user preferences under **Account Security**.
 - Use the API key in place of your password in all JSON-RPC calls.
 
-## Best Practices
+## Best practices
 
-1. **Use API Keys**: Safer than passwords; revoke if compromised.
-2. **Limit Permissions**: Create dedicated users for API access with only necessary rights.
-3. **Validate Responses**: Always check for errors or unexpected results.
-4. **Secure Connections**: Use HTTPS for all API traffic.
-5. **Log and Monitor**: Track API usage for auditing and troubleshooting.
+- **Use API Keys**: Safer than passwords; revoke if compromised.
+- **Limit Permissions**: Create dedicated users for API access with only necessary rights.
+- **Validate Responses**: Always check for errors or unexpected results.
+- **Secure Connections**: Use HTTPS for all API traffic.
+- **Log and Monitor**: Track API usage for auditing and troubleshooting.
 
 ## References
 

docs/developer_guide/api_usage/index.md

@@ -1,9 +1,9 @@
 
 # API Usage
 
-Welcome to the API Usage section of the OpenSPP Developer Guide. This section is your starting point for understanding and integrating with the various APIs that OpenSPP offers. Whether you are building new applications, automating business processes, or connecting external systems, these guides will help you make the most of OpenSPP’s extensible platform.
+This section is your starting point for understanding and integrating with the various APIs that OpenSPP offers. Whether you are building new applications, automating business processes, or connecting external systems, these guides will help you make the most of OpenSPP’s extensible platform.
 
-Here, you will find comprehensive documentation and practical examples for the following API types:
+Here, you can find documentation and practical examples for the following API types:
 
 - {doc}`dci_api` Learn how to leverage the Digital Convergence Initiative (DCI) for robust data exchange and integration scenarios with other digital public infrastructure.
 - {doc}`external_api_jsonrpc`: Explore the JSON-RPC interface for lightweight, remote procedure calls and automation.

docs/developer_guide/developer_mode.md

@@ -3,11 +3,11 @@
 
 # Developer mode (debug mode)
 
-The developer mode (or debug mode) unlocks access to extra and advanced tools in OpenSPP. There are several ways to activate the developer mode: through the Settings or the URL.
+The developer mode (or debug mode) unlocks access to extra and advanced tools in OpenSPP. There are two ways to activate the developer mode; through the Settings or the URL.
 
 ## Activate through the settings
 
-To activate the debug mode, open the OpenSPP database settings, go to **Settings → General Settings → Developer Tools** and click **Activate the developer mode**. Make sure that you have installed at least one app to see the **Developer Tools** section in the **Settings** module.
+Open the OpenSPP database settings, go to **Settings → General Settings → Developer Tools** and click **Activate the developer mode**. Make sure that you have installed at least one app to see the **Developer Tools** section in the **Settings** module.
 
 ![Overview of the debug options under settings in Odoo.](developer_mode/1.png "Overview of the debug options under settings in Odoo.")
 

docs/developer_guide/integrations/dci.md

@@ -1,94 +1,92 @@
 
 # Digital Convergence Initiative
 
-In the rapidly evolving landscape of digital public infrastructure (DPI), the principle of interoperability stands as an important for building efficient, inclusive, and sustainable systems in a country. This article delves into how OpenSPP implemented APIs outlined in the [DCI Interface Standards v1.0](https://standards.spdci.org/standards/standards-for-interoperability-interfaces/structure-and-versioning-of-the-standards) under Registry to enable interoperability with other systems such as CRVS.
+In the rapidly evolving landscape of digital public infrastructure (DPI), the principle of interoperability stands as an important corner stone for building efficient, inclusive, and sustainable systems. This article covers OpenSPP's implementation of APIs outlined in the [DCI Interface Standards v1.0](https://standards.spdci.org/standards/standards-for-interoperability-interfaces/structure-and-versioning-of-the-standards) which enables interoperability with other systems such as CRVS.
 
-The implementation can be categorized into two sections where OpenSPP operates as the client and OpenSPP operates as the server. Note that currently OpenSPP has only completed the sync implementation.
+The implementation allows OpenSPP to operate either as the client or as the server. Note that currently OpenSPP has only completed the sync implementation.
 
-## 1. Server Implementation
+## Server implementation
 
-This section focuses on utilizing OpenSPP as the source of truth for beneficiary information where OpenSPP acts as the server. Such integration allows OpenSPP to seamlessly interact with other critical systems by providing data, thereby enhancing data exchange and operational {term}`efficiency`. The following steps elaborate how the module can be configured.
+This section focuses on utilizing OpenSPP as the source of truth for beneficiary information by providing data, thereby enhancing data exchange and operational {term}`efficiency`. The following steps present the configuration of the module.
 
-### 1.1 Deployment and Installation
+### Deployment and installation
 
-1. Deploy [this branch](https://github.com/OpenSPP/openspp-api/tree/spp_dci_api_server) on a server
+1. Deploy [this branch](https://github.com/OpenSPP/openspp-api/tree/spp_dci_api_server) on a server.
 
 2. Generate RSA Private and Public key.
 
-3. Save the RSA private key to spp_dci_api_server/tools/private_key.pem.
+3. Save the RSA private key to spp_dci_api_server/tools/private_key.pem
 
 4. Save the RSA public key to spp_dci_api_server/tools/public_key.pub
 
-5. Login to OpenSPP, Go to Apps, Search “OpenSPP API: DCI Server” and Install.
+5. Login to OpenSPP and go to Apps. Search for “OpenSPP API: DCI Server” and install.
 
-### 1.2 How to use
+### How to use
 
-1. Login to OpenSPP
+1. Login to OpenSPP.
 
-2. Navigate to Settings -> DCI API Client Credentials
+2. Navigate to Settings and click on DCI API Client Credentials.
 
-3. Click Create button and fill-up the Client Name field then click Save.
+3. Click Create button. Fill in the Client Name field and then click Save.
 
-4. “Show” button will appear.
+4. Click the “Show” button to reveal the Client ID and Client Secret.
 
-5. Click the “Show” button to reveal the Client ID and Client Secret.
+5. Make sure to copy the Client ID and Client Secret.
 
-6. Make sure to copy the Client ID and Client Secret.
+6. Upon closing the modal, “Show” button will not appear anymore and will not be able to reveal the Client ID and Client Secret.
 
-7. Upon closing the modal, “Show” button will not appear anymore and will not be able to reveal the Client ID and Client Secret.
+7. Client ID and Client Secret will be used to retrieve Access Token.
 
-8. Client ID and Client Secret will be used to retrieve Access Token.
+8. Access Token will be used to authenticate in the search Registry API.
 
-9. Access Token will be used to authenticate in the search Registry API.
+9. To retrieve Access Token, Send a POST request to the url `<domain>/oauth2/client/token` with a body client_id, client_secret, and grant_type=’client_credentials’
 
-10. To retrieve Access Token, Send a POST request to the url `<domain>/oauth2/client/token` with a body client_id, client_secret, and grant_type=’client_credentials’
+10. Copy the access_token in the response.
 
-11. Copy the access_token in the response.
+11. To retrieve registry data, Send a POST request to the url `<domain>/registry/sync/search`.
 
-12. To retrieve registry data, Send a POST request to the url `<domain>/registry/sync/search`.
+12. Header should have a key “Authorization” with a value “Bearer <access_token>”
 
-13. Header should have a key “Authorization” with a value “Bearer <access_token>”
+13. Refer to the DCI API spec for the request and response structure.
 
-14. Refer the DCI API spec for the request and response structure
+## Client implementation
 
-## 2. Client Implementation
+This section focuses on utilizing another registry as the source for truth to get beneficiary information that can then be utilized in OpenSPP.
 
-This section focuses on utilizing another registry as the source for truth to get beneficiary information. The following steps elaborate how the module can be configured to fetch data where OpenSPP acts as the client.
-
-### 2.1 Deployment and Installation
+### Deployment and installation
 
 1. Deploy these two branches([1](https://github.com/OpenSPP/openspp-api/tree/spp_crvs_import),[2](https://github.com/OpenSPP/openspp-base/tree/spp_data_source)) on a server
 
-2. Get client_id and client_secret from CRVS(or from server).
+2. Get client_id and client_secret from CRVS (or from server).
 
-3. Login to OpenSPP
+3. Login to OpenSPP.
 
-4. Navigate to the Apps page, Search “OpenSPP Import: DCI API” and Install it.
+4. Navigate to the Apps page. Search for “OpenSPP Import: DCI API” and Install it.
 
 5. Upon installing “OpenSPP Import: DCI API”, a data source is automatically created.
 
-6. Navigate to Settings -> Data Source to view the created data source.
+6. Navigate to Settings and select Data Source to view the created data source.
 
 7. Input the credentials in the client_id, client_secret, and grant_type field inside the Data Source record.
 
-8. The only supported grant_type for now is “client_credentials”.
+NOTE: The only supported grant_type for now is “client_credentials”.
 
-### 2.2 How to use
+### How to use
 
-1. Navigate to Programs -> Import From Registry
+1. Navigate to Programs and select Import From Registry.
 
-2. Create Search Criteria, Enter Search Criteria Name, Location, and Birthdate Range
+2. Create Search Criteria, Enter Search Criteria Name, Location, and Birthdate Range.
 
 3. Click Fetch Button.
 
 4. Individual records will be imported from OpenCRVS Lab to OpenSPP.
 
-5. Fetch Button is now {term}`disabled` but it can be enabled by clicking the “Enable Fetching”.
+5. Fetch Button is now {term}`disabled` but can be enabled by clicking the “Enable Fetching”.
 
-6. Once an individual record is already fetched, They are now created and visible to the Registry page.
+6. Once an individual record is fetched, it is created and visible to the Registry page.
 
-7. Navigate to Registry -> Individual to check the individuals and Navigate to Registry -> Group to check the groups.
+7. Navigate to Registry and select Individual to check the individuals. Select Group to check the groups.
 
-8. Refer the DCI API spec for the request and response structure
+8. Refer the DCI API spec for the request and response structure.
 
 _NOTE: This documentation/implementation should be considered as an alpha release of the implementation of the DCI Interface Standards v1.0._

docs/developer_guide/integrations/esignet.md

@@ -1,18 +1,16 @@
 
 # eSignet Integration
 
-## Introduction
-
-The integration of OpenSPP with eSignet aims to utilize [MOSIP eSignet](https://docs.mosip.io/1.2.0/integrations/e-signet) as the identity server for login into the OpenSPP platform. This provides a seamless user experience and enhances security by leveraging the OAuth protocol and allowing OpenSPP users to access the platform without the need for additional login credentials.
+The integration of OpenSPP with eSignet utilizes [MOSIP eSignet](https://docs.mosip.io/1.2.0/integrations/e-signet) as the identity server for login into the OpenSPP platform. This provides a seamless user experience and enhances security by leveraging the OAuth protocol and allowing OpenSPP users to access the platform without the need for additional login credentials.
 
 ## Prerequisites
 
 To be able to start the integration, ensure the following:
 
 - The key exchange is completed as per the requirements of MOSIP.
 - Access to the eSignet account (Client ID) and Authorization URL, UserInfo URL, Token URL, and JWKS URL is received from MOSIP.
-- Need to have administrative privileges within OpenSPP to install modules.
-- The developer mode is activated in OpenSPP.
+- Administrative privileges within OpenSPP to install modules.
+- Developer mode is activated in OpenSPP.
 
 ## Objective
 

docs/developer_guide/integrations/index.md

@@ -1,7 +1,7 @@
 
 # Integrations
 
-This section provides comprehensive guides for connecting OpenSPP with external systems, identity providers, and other digital public infrastructure components. These integrations are key to building a robust and interoperable social protection ecosystem.
+This section provides guides for connecting OpenSPP with external systems, identity providers, and other digital public infrastructure components. These integrations are key to building a robust and interoperable social protection ecosystem.
 
 In addition to the list to the ones listed below, we also have integration with OpenCRVS and OpenFN.