Fixes of some documents

Author: gonzalesedwin1123

docs/community/contributing.md

@@ -1,6 +1,6 @@
 ---
 review-status: needs-review
-review-date: 2025-06-04
+review-date: 2025-09-01
 reviewer: migration-script
 migration-notes: "Added during 2025 documentation reorganization"
 ---
@@ -164,56 +164,7 @@ pip install -r requirements.txt
 make html
 ```
 
----
-
-<!-- Commented this section out, this whole commented section is all from the old documentation version. unless there are relevant information from this section, we'll comment this part for now (administrators-guide-label)=
-
-# Administrators Guide
-
-This guide is for administrators of OpenSPP Documentation.
-It covers automated deployments, hosting, automated testing, previewing, and importing external package documentation into OpenSPP Documentation.
-
-(administrators-import-docs-submodule-label)=
-
-## Importing external docs with submodules
-
-To add an external package to OpenSPP Documentation, we use git submodules.
-Your package must be available under the OpenSPP GitHub organization.
-
-Inside the repository `openspp/documentation`, add a git submodule that points to your project.
-
-```shell
-git submodule add git@github.com:openspp/my_package.git submodules/my_package
-```
-
-Add a target `docs/my_package` in `Makefile`, then add `docs/my_package` to the `deps` target, following `openspp_registry` as a pattern.
-You might need to adjust the paths to your package's documentation after it is cloned.
-
-To complete setup, generate a symlink to your project's docs, and build the docs, use a single command.
-
-```shell
-make html
-```
-
-To make it easier for other contributors to work with your project, update the following files, using `openspp_registry` as a model.
- 
--   Add it to the documentation section {ref}`contributing-editing-external-package-documentation-label`.
--   Add the symlink `docs/my_package` to `.gitignore`.
--   Optionally set a branch to work on in `.gitmodules`.
-
-Commit and push your changes to a remote, and submit a pull request against [`openspp/documentation`](https://github.com/openspp/documentation/compare).
-
-(authors-guide-label)=
--->
-
-# Authors guide
-
-This guide is for authors of OpenSPP Documentation.
-It covers how to run a live preview of documentation while editing, build documentation, and perform quality checks.
-For general markup syntax, see {doc}`myst-reference`.
-
-
-## Synchronize the browser while editing
+### Synchronize the browser while editing
 
 Use `sphinx-autobuild` to view changes in the browser while you edit documentation.
 
@@ -223,32 +174,6 @@ make livehtml
 
 You can open a browser at http://127.0.0.1:8050/ to preview the documentation.
 
-
-<!-- Commented this section out, this whole commented section is all from the old documentation version. unless there are relevant information 
-(authors-quality-checks-label)=
-
-## Quality checks
-
-We strive for high quality documentation, setting the following minimum standards.
-
-
-(authors-markup-syntax-label)=
-
-### Markup syntax must be valid
-
-See both the specific markup syntax above and general markup in {doc}`myst-reference`.
-
-To validate markup, run the following command.
-
-```shell
-make html
-```
-
-Open `/_build/html/index.html` in a web browser.
-
-
-(authors-english-label)=
-
 ### American English spelling, grammar, and syntax, and style guide
 
 Spellings are enforced through [`Vale`](https://vale.sh/).
@@ -272,9 +197,6 @@ We also understand that contributors might not be fluent in English.
 We encourage contributors to make a reasonable effort, and to request a review of their pull request from community members who are fluent in English to fix grammar and syntax.
 Please ask!
 
-
-(authors-linkcheck-label)=
-
 ### All links must be valid
 
 ```{important}
@@ -320,9 +242,6 @@ And there is a doubly punishing place for those who disable `linkcheck` because
 Please do not be "that person".
 ```
 
-
-(authors-syntax-highlighting-label)=
-
 ### Syntax highlighting
 
 Pygments provides syntax highlighting in Sphinx.
@@ -395,8 +314,6 @@ When using the online lexer, if any red-bordered rectangles appear, then the lex
 You can search the [Pygments issue tracker](https://github.com/pygments/pygments/search) for possible solutions, or submit a pull request to enhance the lexer.
 
 
-(authors-html-meta-data-label)=
-
 ### HTML and Open Graph metadata
 
 All documents must have a `myst` topmatter key with an `html_meta` directive at the top of every page.
@@ -512,8 +429,6 @@ Here is how to set up and build the documentation locally {doc}`/contributing/se
 
 Here is how to set up and build the documentation locally {doc}`/contributing/setup-build`.
 
-(myst-reference-link-heading-label)=
-
 #### Link to a heading
 
 ```md
@@ -524,8 +439,6 @@ Here is how to set up and build the documentation locally {doc}`/contributing/se
 Read the section {ref}`myst-reference-link-heading-label`.
 ```
 
-(myst-reference-hello-heading-label)=
-
 ##### Hello heading
 
 Read the section {ref}`myst-reference-hello-heading-label`.
@@ -563,8 +476,6 @@ Use `image` for anything but diagrams.
 
 Use `figure` for diagrams.
 
-(static-assets-label)=
-
 #### Static assets
 
 When the documentation is in a submodule, paths to static assets—including, images, figures, and videos—must resolve in both the main documentation and the submodule's documentation.
@@ -630,7 +541,7 @@ The following MyST example will display as shown below.
 ```
 ````
 
-```{image} /_static/standards.png
+```{image} ../_static/standards.png
 :alt: XKCD "Standards" comic strip
 ```
 
@@ -856,31 +767,23 @@ print(f"my {a}nd line")
 ````
 
 
-(setup-build-label)=
-
 # Building and checking the quality of documentation
 
 This document covers how to build the OpenSPP Documentation and check it for quality.
 
 
-(setup-build-installation-label)=
-
 ## Installation
 
 Installation of OpenSPP Documentation includes pre-requisites and the repository itself.
 
 
-(setup-build-installation-python-label)=
-
 ### Python
 
 Python 3.8 or later is required.
 A more recent Python is preferred.
 Use your system's package manager or [pyenv](https://github.com/pyenv/pyenv) to install an appropriate version of Python.
 
 
-(setup-build-installation-vale-label)=
-
 ### Vale
 
 Vale is a linter for narrative text.
@@ -906,8 +809,6 @@ This is an easy way to become a contributor to OpenSPP.
 ```
 
 
-(setup-build-installation-graphviz-label)=
-
 ### Graphviz
 
 Install [Graphviz](https://graphviz.org/download/) for graph visualization.
@@ -927,8 +828,6 @@ sudo apt-get install graphviz
 `````
 
 
-(setup-build-installation-clone-OpenSPP-documentation-label)=
-
 ### Clone `OpenSPP/documentation`
 
 Clone the OpenSPP Documentation repository, and change your working directory into the cloned project.
@@ -940,8 +839,6 @@ cd documentation
 make html
 ```
 
-(setup-build-available-documentation-builds-label)=
-
 ## Available documentation builds
 
 All build and check documentation commands use the file `Makefile`.
@@ -974,7 +871,7 @@ Open `/_build/html/index.html` in a web browser.
 make livehtml
 ```
 
-Open http://0.0.0.0:8000/ in a web browser.
+Open http://127.0.0.1:8050/ in a web browser.
 
 
 ### `linkcheck`
@@ -1010,8 +907,6 @@ See {ref}`authors-html-meta-data-label` for more info.
 make html_meta
 ```
 
-(contributing-sphinx-extensions)=
-
 # Sphinx extensions
 
 We use several Sphinx extensions to enhance the presentation of OpenSPP documentation.
@@ -1021,11 +916,8 @@ We use several Sphinx extensions to enhance the presentation of OpenSPP document
 -   [`sphinx.ext.todo`](https://www.sphinx-doc.org/en/master/usage/extensions/todo.html) adds support for todo items.
 -   [`sphinx_copybutton`](https://sphinx-copybutton.readthedocs.io/en/latest/index.html)  adds a little "copy" button to the right of code blocks.
 -   [`sphinx-design`](https://sphinx-design.readthedocs.io/en/latest/) adds grids, cards, icons, badges, buttons, tabs, and dropdowns.
--   [`sphinx_sitemap`](https://pypi.org/project/sphinx-sitemap/) generates multiversion and multilanguage [sitemaps.org](https://www.sitemaps.org/protocol.html) compliant sitemaps.
 -   [`sphinxcontrib.httpdomain`](https://sphinxcontrib-httpdomain.readthedocs.io/en/stable/) provides a Sphinx domain for describing HTTP APIs.
 -   [`sphinxcontrib.httpexample`](https://sphinxcontrib-httpexample.readthedocs.io/en/latest/) enhances `sphinxcontrib-httpdomain` by generating RESTful HTTP API call examples for different tools from a single HTTP request example.
     Supported tools include [curl](https://curl.se/), [wget](https://www.gnu.org/software/wget/), [httpie](https://httpie.io/), and [python-requests](https://requests.readthedocs.io/en/latest/).
--   [`sphinxcontrib.video`](https://pypi.org/project/sphinxcontrib-video/) allows you to embed local videos as defined by the HTML5 standard.
--   [`sphinxext.opengraph`](https://pypi.org/project/sphinxext-opengraph/) generates [OpenGraph metadata](https://ogp.me/).
 -   [`sphinx.ext.viewcode`](https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html) generates pages of source code modules and links between the source and the description.
 -   [`sphinx.ext.autosummary`](https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html) generates function/method/attribute summary lists. -->

docs/community/module_lifecycle_development_status.rst

@@ -6,7 +6,7 @@ The requirements to merge code into OpenSPP projects depend on the module's
 maturity level.
 
 The OpenSPP uses the following maturity levels for the modules stored in the
-Github repository and published in PyPi platform:
+Github repository:
 
 -  **Alpha:** Unstable, for development or testing purpose
 
@@ -17,9 +17,6 @@ Github repository and published in PyPi platform:
 -  **Mature:** In Production level since more than one version and
    actively maintained.
 
-This is consistent with the terminology used on PyPi, and the allowed
-values are the same as the ones used by PyPi.
-
 A module maturity level is stored in the **development\_status** key of
 the standard manifest of the module (\_\_manifest\_\_.py).
 
@@ -38,9 +35,6 @@ A module’s development\_status can be different for different versions.
 A “mature” or “stable” module in a version can start as “stable” or
 “beta” in the next branch, as a step towards maturity.
 
-All modules, regardless of their development status, will be published
-on PyPi.
-
 Next we describe in detail what each 'development status' means, what
 can be expected by users, and what are the requirements for modules to
 be assigned each maturity level.
@@ -56,8 +50,8 @@ that are easier to review and make it easier to divide the work between
 several people.
 
 Each pull request is an iteration providing a correct set of features.
-The corresponding code should always pass TravisCI checks and should
-have at least one peer review.
+The corresponding code should always pass the CI checks on GitHub Actions and
+should have at least one peer review.
 
 Since these modules are a work in progress toward a “stable” module,
 they are not suitable for use in production. The design and

docs/developer_guide/module_development/index.md

@@ -31,17 +31,28 @@ For developers new to Odoo, it might seem easier to directly edit the existing O
 
 In short, creating modules is the professional standard for Odoo and OpenSPP development that ensures your solution is robust and future-proof.
 
-This modular approach is the foundation for all advanced customizations. From here, you can explore:
-- Adding more complex field types (Selection, Many2one, etc.).
-- Creating entirely new models and menus.
-- Adding business logic with Python methods.
-
-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.
-
 ## Best Practices in OpenSPP Development
 
 For more detailed guidelines, refer to the {doc}`Best Practices Guide <../best_practices>`.
 
+## Module Customization Guides
+
+The following guides provide step-by-step instructions for common customization tasks in OpenSPP. Each guide focuses on a specific area of the platform, showing you how to extend its functionality by creating a custom module.
+
+- **{doc}`fields`**: Learn how to add new fields to existing models.
+- **{doc}`registry`**: Extend the core registry models for individuals and groups.
+- **{doc}`indicators`**: Create and manage custom indicators for eligibility checking, reporting, and analysis.
+- **{doc}`programs`**: Customize program definitions and behavior.
+- **{doc}`cycles`**: Modify program cycles and their states.
+- **{doc}`entitlements`**: Customize the logic for calculating and managing entitlements.
+- **{doc}`change_requests`**: Build new types of change requests to handle custom data modification workflows.
+- **{doc}`dms`**: Extend the Document Management System (DMS) with custom categories and logic.
+- **{doc}`rest_api`**: Create new REST API endpoints for integration with external systems.
+- **{doc}`areas`**: Customize geographical area data, such as adding population statistics.
+- **{doc}`service_points`**: Extend the functionality of service points.
+- **{doc}`audit`**: Configure and extend audit logging for tracking changes to critical data.
+- **{doc}`dashboard`**: Develop custom dashboards and reporting views.
+
 ## References
 
 For more information on developing OpenSPP modules, refer to:
@@ -53,17 +64,17 @@ For more information on developing OpenSPP modules, refer to:
 :hidden: true
 :caption: Contents
 
-areas
-audit
-change_requests
-cycles
-dashboard
-dms
-entitlements
 fields
+registry
 indicators
 programs
-registry
+cycles
+entitlements
+change_requests
+dms
 rest_api
+areas
 service_points
+audit
+dashboard
 ```