Merge pull request #64 from OpenSPP/cleanup-build-errors

Cleanup build errors
Update documents from reviewing during call

Author: anthonymarkQA

docs/community/contributing.md

@@ -16,7 +16,7 @@ We expect all contributors to the OpenSPP project to adhere to our [Code of Cond
 This document outlines the standards of behavior that we expect from all members of the community, and
 provides guidance on how to report any incidents of misconduct.
 
-## **Did you find a bug?**
+## Did you find a bug?
 
 - **Do not open up a GitHub issue if the bug is a security vulnerability in OpenSPP**, and instead follow the
   [security disclosure policy](security_report).

docs/developer_guide/architecture.md

@@ -250,93 +250,4 @@ Furthermore, as OpenSPP is based on the ERP Odoo and use the standard models pro
 to the thousands of applications available in the [Odoo App Store](https://apps.odoo.com/apps) or build your
 [own](https://www.odoo.com/documentation/17.0/developer.html).
 
-### Example components for a mid-size project
 
-![](images/architecture_ecosystem_1.png)
-
-### Example components for a large project
-
-![](images/openspp_architecture_large_project.png)
-
-
----
-
-## Merged Content
-
-
-
-### Content from docs/technical_reference/programs/concepts.md
-
-# Manager Overview
-
-![OpenSPP Overview](images/openspp_overview.png)
-
-## Programs
-
-Programs, sometimes also called a campaign, define a social program. A program is defining when, what and how
-{term}`beneficiaries` receive {term}`entitlements`. In itself, a program does not do much. The power comes through the use of
-"managers", which define the journey of beneficiaries in a program.
-
-Currently, few types of programs are supported:
-
-- Cash transfer
-- Mobile money
-- Voucher
-- Voucher for restricted cash
-
-## Cycle
-
-Cycles represent a distribution cycle.
-
-## beneficiary
-
-A beneficiary is a {term}`registrant` that is part of a program/cycle.
-
-## Managers
-
-There are different types of managers that define how programs and cycles work. Each manager type has a
-defined programming API that needs to be implemented in order to define how the system will work.
-
-For all the managers, a default implementation is designed to support the most common use cases. You can
-easily add your managers if those do not fit your needs.
-
-The available managers are:
-
-- [Eligibility Manager](eligibility_manager.rst)
-- [Entitlement Manager](entitlement_manager.rst)
-- [Deduplication Manager](deduplication_manager.md)
-- [Notification Manager](notification_manager.rst)
-- [Program Manager](program_manager.rst)
-- [Cycle Manager](cycle_manager.rst)
-
-## Type of payment instruments
-
-### Cash Transfer
-
-**STATUS**: Work In Progress.
-
-OpenSPP can generate payment lists that can be shared with a bank to verify or execute transfers.
-
-### Mobile money
-
-TBD
-
-### Voucher program
-
-OpenSPP can generate nominative vouchers in batches ready to be printed.
-
-The design of the vouchers can be customized by updating the voucher template.
-
-::::{important}
-
-If you plan to accept vouchers and do not plan to verify them with the server at the time of accepting then
-you should think about what security features you need to implement to avoid having them being duplicated.
-
-We recommend the use of online verification when the voucher is received or the use of secure paper.
-
-::::
-
-### Voucher for restricted cash programs
-
-Vouchers can be used in conjunction with Odoo POS to provide restricted cash solutions. A merchant can use the
-Odoo POS to record what is distributed against a given voucher.

docs/developer_guide/best_practices.md

@@ -9,7 +9,7 @@ migration-notes: "Added during 2025 documentation reorganization"
 
 OpenSPP follows the coding standards of the [Odoo Community Association (OCA)](https://github.com/OCA/odoo-community.org/blob/master/website/Contribution/CONTRIBUTING.rst), which are designed to ensure high-quality, maintainable, and consistent code. While the full guidelines are extensive, here are some of the most important best practices to follow:
 
-**Enforce Coding Standards with Pre-Commit:**
+## Enforce Coding Standards with Pre-Commit
 - OpenSPP uses `pre-commit` to automatically enforce **PEP8** and other coding standards. This is the recommended way to ensure your code is compliant before committing.
 - The configuration runs tools like `black` (formatting), `isort` (import sorting), and `flake8` (linting).
 - To set it up, run these commands once in your repository:
@@ -19,21 +19,21 @@ OpenSPP follows the coding standards of the [Odoo Community Association (OCA)](h
   ```
 - After setup, these checks will run automatically on every `git commit`. If an issue is found, the commit will be stopped, and some tools may automatically fix the files for you.
 
-**Embrace Test-Driven Development (TDD):**
+## Embrace Test-Driven Development (TDD)
 - All new features and bug fixes must follow a Test-Driven Development approach. Write tests that define and validate the functionality *before* writing the implementation.
 - Every module must include a comprehensive test suite to ensure its correctness and prevent future regressions.
 - Tests should be placed in a `tests/` subdirectory within your module and will be automatically discovered by Odoo's test runner.
 - This practice is critical for maintaining a high-quality, stable, and maintainable codebase.
 
-**Write Clean and Readable XML:**
+## Write Clean and Readable XML
 - Use a consistent naming convention for record IDs. For example: `view_model_name_form`, `action_model_name_window`.
 - Logically order fields in views to create an intuitive user experience.
 
-**Prioritize Security and Extensibility:**
+## Prioritize Security and Extensibility
 - Always define access rights in `security/ir.model.access.csv`. Never grant universal access (`group_id:id,"",...`) without a strong reason.
 - Avoid using raw SQL queries. Use the Odoo ORM to ensure security rules are respected.
 - Always use `_inherit` and `xpath` to extend existing functionality. Never modify core OpenSPP or Odoo files directly.
 
-**Adhere to Licensing Requirements:**
+## Adhere to Licensing Requirements
 - All custom modules for OpenSPP must be licensed under **LGPL-3**.
 - Ensure that any third-party Python libraries or other dependencies you add are compatible with the LGPL-3 license.

docs/developer_guide/module_development/audit.md

@@ -163,7 +163,7 @@ For parent/child rules (requires `spp_audit_post`), also pass `parent_rule_name`
 
 ## Best Practices
 
-- **Use Targeted Field Lists**: Keep `field_to_log_ids` focused on business-critical fields.
+**Use Targeted Field Lists**: Keep `field_to_log_ids` focused on business-critical fields.
 
 ## References
 

docs/developer_guide/module_development/change_requests.md

@@ -377,7 +377,7 @@ access_spp_change_request_add_children_user,spp.change.request.add.children.user
 
 ## Best Practices
 
-- Always start with a clear definition of the data you need to collect and the system changes that need to occur upon approval.
+Always start with a clear definition of the data you need to collect and the system changes that need to occur upon approval.
 
 ## References
 

docs/developer_guide/module_development/index.md

@@ -35,7 +35,6 @@ This modular approach is the foundation for all advanced customizations. From he
 - Adding more complex field types (Selection, Many2one, etc.).
 - Creating entirely new models and menus.
 - Adding business logic with Python methods.
-- Building more advanced features documented in the {doc}`Module Development Guides <index>`.
 
 By mastering this pattern, you can tailor OpenSPP to meet any specific program requirement while ensuring your implementation remains clean, stable, and easy to maintain.
 

docs/developer_guide/troubleshooting.md

@@ -9,30 +9,30 @@ migration-notes: "Added during 2025 documentation reorganization"
 
 This guide offers insights and solutions for common errors encountered in Odoo application development. Understanding these errors and knowing how to address them efficiently is crucial for maintaining a smooth development process.
 
-1. Error: Field “x” does not exist in model “y”
+**Error: Field “x” does not exist in model “y”**
 
-   - Confirm the field's presence in the model.
-   - Ensure the Python file is listed in `models/__init__.py`.
-   - Verify the existence of from . import models in the `__init__.py` file.
-   - Consider upgrading the module.
-   - Double-check the field name for any spelling errors.
+   1. Confirm the field's presence in the model.
+   2. Ensure the Python file is listed in `models/__init__.py`.
+   3. Verify the existence of from . import models in the `__init__.py` file.
+   4. Consider upgrading the module.
+   5. Double-check the field name for any spelling errors.
 
-2. Error: Unable to install module “x” due to an unmet external dependency: Missing Python library “y”, “z”
+**Error: Unable to install module “x” due to an unmet external dependency: Missing Python library “y”, “z”**
 
-   - Execute pip install -r requirements.txt to install the module's required Python libraries.
-   - If specific libraries are mentioned in the error, install them individually using pip.
+   1. Execute pip install -r requirements.txt to install the module's required Python libraries.
+   2. If specific libraries are mentioned in the error, install them individually using pip.
 
-3. Error: Invalid field “x” on model “y”
+**Error: Invalid field “x” on model “y”**
 
-   - Ensure the field exists within the model.
-   - Restart the Odoo server and then upgrade the module.
+   1. Ensure the field exists within the model.
+   2. Restart the Odoo server and then upgrade the module.
 
-4. Error: Some modules are not loaded, potentially due to missing dependencies or manifests: [“x”]
+**Error: Some modules are not loaded, potentially due to missing dependencies or manifests: [“x”]**
 
-   - Check if the module is located in the custom/ or custom/src/ folder. If absent, add the module, restart the Odoo server, and attempt reinstallation.
-   - Confirm the existence of the dependency module of the missing module in either the custom/ or custom/src/ folder.
+   1. Check if the module is located in the custom/ or custom/src/ folder. If absent, add the module, restart the Odoo server, and attempt reinstallation.
+   2. Confirm the existence of the dependency module of the missing module in either the custom/ or custom/src/ folder.
 
-5. Error: Inconsistent module states, possibly due to missing dependencies: [“x”]
+**Error: Inconsistent module states, possibly due to missing dependencies: [“x”]**
 
-   - This issue often arises when a dependency of the “x” module encounters an error.
-   - Explore and rectify errors in other related modules.
+   1. This issue often arises when a dependency of the “x” module encounters an error.
+   2. Explore and rectify errors in other related modules.

docs/overview/features/integrations_apis.md

@@ -27,6 +27,6 @@ OpenSPP is versatile regarding API communication, supporting various methods suc
 
 With respect to API versioning management, OpenSPP currently manages this aspect manually. This approach ensures backward compatibility, allowing older API versions to continue functioning alongside newer ones. It also fosters forward innovation, facilitating the development of new API features. However, to further streamline this process, OpenSPP plans to deploy an API Manager.
 
-OpenSPP supports sandboxing for API testing, ensuring APIs perform optimally in real-world scenarios. Invitation-only access is provided to demo.openspp.org, allowing prospective integrations to be thoroughly tested and tweaked in a controlled environment before they are deployed in production.
+OpenSPP supports sandboxing for API testing, ensuring APIs perform optimally in real-world scenarios. Invitation-only access is provided to our demo instance, allowing prospective integrations to be thoroughly tested and tweaked in a controlled environment before they are deployed in production.
 
 [More Infomation](/technical_reference/external_api.html)

docs/overview/index.md

@@ -11,8 +11,9 @@ Welcome to the OpenSPP overview section. This section provides high-level inform
 
 - {doc}`features/index`  
 - {doc}`use_cases/index`  
-- {doc}`concepts/index`  
-<!-- - {doc}`case_studies/index` -->
+- {doc}`case_studies/index`
+- {doc}`poc_and_pilot`
+
 
 
 ```{toctree}
@@ -22,6 +23,6 @@ Welcome to the OpenSPP overview section. This section provides high-level inform
 
 features/index
 use_cases/index
-concepts/index
-<!-- case_studies/index -->
+case_studies/index
+poc_and_pilot
 ```