Skip to content

Commit b335808

Browse files
Simpleshell3Simpleshell3
authored
Merge pull request #14 from moja-global/docs/enterprise-upgrade-2026-03-27
Update documentation glossary and metadata
2 parents 15bfdda + 03552e8 commit b335808

18 files changed

Lines changed: 895 additions & 877 deletions

‎docs/WALKTHROUGH.md‎

Lines changed: 52 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,52 @@
1-
# Quickstart Walkthrough
2-
3-
Use this page for the fastest path from install to interpreted outputs.
4-
5-
## Document Control
6-
7-
| Field | Value |
8-
| --- | --- |
9-
| Owner | GCBM Assistant maintainers |
10-
| Audience | First-time users |
11-
| Last reviewed | 2026-03-27 |
12-
| Review cadence | Monthly |
13-
14-
## Step 1: Install and Launch
15-
16-
Follow [Legacy Installation](guide/installation.md) to install from source or
17-
installer, then launch GCBM Assistant.
18-
19-
## Step 2: Run Simulation
20-
21-
Follow [Simulation Playbook](playbooks/simulation.md).
22-
23-
Minimum success criteria:
24-
25-
- validation succeeds
26-
- simulation completes
27-
- output artifacts are created
28-
29-
## Step 3: Compile Outputs
30-
31-
Follow [Compilation Playbook](playbooks/compilation.md).
32-
33-
Minimum success criteria:
34-
35-
- compiled DB generated
36-
- spatial TIFF outputs generated if map mode is needed
37-
38-
## Step 4: Visualize and Export
39-
40-
Follow [Visualization Playbook](playbooks/visualization.md).
41-
42-
Minimum success criteria:
43-
44-
- charts render from compiled DB
45-
- optional map mode loads for spatial outputs
46-
- export artifacts generated
47-
48-
## If Something Fails
49-
50-
- Start with [Troubleshooting Matrix](operations/troubleshooting-matrix.md)
51-
- Check [Known Issues](operations/known-issues.md)
1+
# Quickstart Walkthrough
2+
3+
Use this page for the fastest path from install to interpreted outputs.
4+
5+
## Document Control
6+
7+
| Field | Value |
8+
| --- | --- |
9+
| Author | Geraldson Muluh |
10+
| Owner | GCBM Assistant maintainers |
11+
| Audience | First-time users |
12+
| Last reviewed | 2026-03-27 |
13+
| Review cadence | Monthly |
14+
15+
## Step 1: Install and Launch
16+
17+
Follow [Legacy Installation](guide/installation.md) to install from source or
18+
installer, then launch GCBM Assistant.
19+
20+
## Step 2: Run Simulation
21+
22+
Follow [Simulation Playbook](playbooks/simulation.md).
23+
24+
Minimum success criteria:
25+
26+
- validation succeeds
27+
- simulation completes
28+
- output artifacts are created
29+
30+
## Step 3: Compile Outputs
31+
32+
Follow [Compilation Playbook](playbooks/compilation.md).
33+
34+
Minimum success criteria:
35+
36+
- compiled DB generated
37+
- spatial TIFF outputs generated if map mode is needed
38+
39+
## Step 4: Visualize and Export
40+
41+
Follow [Visualization Playbook](playbooks/visualization.md).
42+
43+
Minimum success criteria:
44+
45+
- charts render from compiled DB
46+
- optional map mode loads for spatial outputs
47+
- export artifacts generated
48+
49+
## If Something Fails
50+
51+
- Start with [Troubleshooting Matrix](operations/troubleshooting-matrix.md)
52+
- Check [Known Issues](operations/known-issues.md)

‎docs/api.md‎

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,44 @@
1-
# API and Module Reference
2-
3-
GCBM Assistant is primarily a desktop UI application, but its internal module
4-
structure is stable enough for extension workflows.
5-
6-
## Document Control
7-
8-
| Field | Value |
9-
| --- | --- |
10-
| Owner | GCBM Assistant maintainers |
11-
| Audience | Developers and integrators |
12-
| Last reviewed | 2026-03-27 |
13-
| Review cadence | Monthly |
14-
15-
## Entry Points
16-
17-
- CLI script: `gcbm-assistant`
18-
- Python module entry: `python -m gcbm_assistant.app`
19-
- Script target: `gcbm_assistant.app:main`
20-
21-
## Core Modules
22-
23-
| Module | Responsibility |
24-
| --- | --- |
25-
| `gcbm_assistant.app` | App bootstrap, routing, global page registration |
26-
| `gcbm_assistant.pages.simulation` | Simulation UI, config validation, run orchestration |
27-
| `gcbm_assistant.pages.compile` | Compilation workflow UI and output generation |
28-
| `gcbm_assistant.pages.visualize` | Chart and spatial visualization orchestration |
29-
| `gcbm_assistant.pages.spatial` | Raster processing, map rendering helpers, spatial scanning |
30-
| `gcbm_assistant.pages.data` | Database access helpers for visualization and reporting |
31-
| `gcbm_assistant.pages.reports` | Report generation and export UI |
32-
33-
## Stable Interface Expectations
34-
35-
- Internal function signatures are not versioned as public SDK interfaces.
36-
- Extensions should prefer page-level hooks and existing state access patterns.
37-
- Any custom integration should pin to a release tag and re-validate on upgrade.
38-
39-
## Repository and Contribution Context
40-
41-
- Source root: `src/gcbm_assistant`
42-
- Tests: `tests/`
43-
- Packaging metadata: `pyproject.toml`
44-
- Repository: <https://github.com/moja-global/gcbm_assistant>
1+
# API and Module Reference
2+
3+
GCBM Assistant is primarily a desktop UI application, but its internal module
4+
structure is stable enough for extension workflows.
5+
6+
## Document Control
7+
8+
| Field | Value |
9+
| --- | --- |
10+
| Author | Geraldson Muluh |
11+
| Owner | GCBM Assistant maintainers |
12+
| Audience | Developers and integrators |
13+
| Last reviewed | 2026-03-27 |
14+
| Review cadence | Monthly |
15+
16+
## Entry Points
17+
18+
- CLI script: `gcbm-assistant`
19+
- Python module entry: `python -m gcbm_assistant.app`
20+
- Script target: `gcbm_assistant.app:main`
21+
22+
## Core Modules
23+
24+
| Module | Responsibility |
25+
| `gcbm_assistant.app` | App bootstrap, routing, global page registration |
26+
| `gcbm_assistant.pages.simulation` | Simulation UI, config validation, run orchestration |
27+
| `gcbm_assistant.pages.compile` | Compilation workflow UI and output generation |
28+
| `gcbm_assistant.pages.visualize` | Chart and spatial visualization orchestration |
29+
| `gcbm_assistant.pages.spatial` | Raster processing, map rendering helpers, spatial scanning |
30+
| `gcbm_assistant.pages.data` | Database access helpers for visualization and reporting |
31+
| `gcbm_assistant.pages.reports` | Report generation and export UI |
32+
33+
## Stable Interface Expectations
34+
35+
- Internal function signatures are not versioned as public SDK interfaces.
36+
- Extensions should prefer page-level hooks and existing state access patterns.
37+
- Any custom integration should pin to a release tag and re-validate on upgrade.
38+
39+
## Repository and Contribution Context
40+
41+
- Source root: `src/gcbm_assistant`
42+
- Tests: `tests/`
43+
- Packaging metadata: `pyproject.toml`
44+
- Repository: <https://github.com/moja-global/gcbm_assistant>

‎docs/governance/ownership-and-maintenance.md‎

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,32 @@
1-
# Ownership and Maintenance
2-
3-
This page defines document ownership and maintenance responsibility for the
4-
major GCBM Assistant documentation areas.
5-
6-
## Document Control
7-
8-
| Field | Value |
9-
| --- | --- |
10-
| Owner | GCBM Assistant maintainers |
11-
| Last reviewed | 2026-03-27 |
12-
| Review cadence | Monthly |
13-
14-
## Documentation Ownership Matrix
15-
16-
| Area | Primary owner | Backup owner | Review cadence |
17-
| --- | --- | --- | --- |
18-
| Home and quickstart | GCBM Assistant maintainers | Release engineer | Monthly |
19-
| Simulation playbook | Simulation workflow maintainer | Product support | Monthly |
20-
| Compilation playbook | Compilation workflow maintainer | Product support | Monthly |
21-
| Visualization playbook and reference | Visualization workflow maintainer | Product support | Monthly |
22-
| Operations docs (support, issues, troubleshooting) | Product support | Release engineer | Monthly |
23-
| Release policy and CI docs | Release engineer | Repository maintainer | Monthly |
24-
| Methodology docs | Science lead or delegate | Product support | Quarterly |
25-
26-
## Maintenance Rules
27-
28-
1. Product behavior changes require same-PR docs updates.
29-
1. CI docs quality checks are required before merge.
30-
1. Known issues page must be updated for user-facing regressions.
31-
1. Major version releases require policy and quickstart review.
1+
# Ownership and Maintenance
2+
3+
This page defines document ownership and maintenance responsibility for the
4+
major GCBM Assistant documentation areas.
5+
6+
## Document Control
7+
8+
| Field | Value |
9+
| --- | --- |
10+
| Author | Geraldson Muluh |
11+
| Owner | GCBM Assistant maintainers |
12+
| Last reviewed | 2026-03-27 |
13+
| Review cadence | Monthly |
14+
15+
## Documentation Ownership Matrix
16+
17+
| Area | Primary owner | Backup owner | Review cadence |
18+
| --- | --- |
19+
| Home and quickstart | GCBM Assistant maintainers | Release engineer | Monthly |
20+
| Simulation playbook | Simulation workflow maintainer | Product support | Monthly |
21+
| Compilation playbook | Compilation workflow maintainer | Product support | Monthly |
22+
| Visualization playbook and reference | Visualization workflow maintainer | Product support | Monthly |
23+
| Operations docs (support, issues, troubleshooting) | Product support | Release engineer | Monthly |
24+
| Release policy and CI docs | Release engineer | Repository maintainer | Monthly |
25+
| Methodology docs | Science lead or delegate | Product support | Quarterly |
26+
27+
## Maintenance Rules
28+
29+
1. Product behavior changes require same-PR docs updates.
30+
1. CI docs quality checks are required before merge.
31+
1. Known issues page must be updated for user-facing regressions.
32+
1. Major version releases require policy and quickstart review.

‎docs/guide/installation.md‎

Lines changed: 64 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,64 @@
1-
# Installation Guide (Legacy)
2-
3-
This page contains installation details. Operational usage should follow the
4-
playbooks.
5-
6-
## Document Control
7-
8-
| Field | Value |
9-
| --- | --- |
10-
| Owner | GCBM Assistant maintainers |
11-
| Last reviewed | 2026-03-27 |
12-
| Review cadence | Monthly |
13-
14-
## Prerequisites
15-
16-
- Python `>=3.10`
17-
- `uv` (recommended) or `pip`
18-
- Windows installer users do not need local Python setup
19-
20-
## Source Installation
21-
22-
```bash
23-
git clone https://github.com/moja-global/gcbm_assistant.git
24-
cd gcbm_assistant
25-
uv pip install -e .
26-
gcbm-assistant
27-
```
28-
29-
Alternative launch:
30-
31-
```bash
32-
python -m gcbm_assistant.app
33-
```
34-
35-
## Windows Installer
36-
37-
1. Download the latest `GCBM_Assistant_Setup_*.exe`.
38-
1. Run the installer.
39-
1. Launch from desktop shortcut.
40-
41-
## Building the Installer (Developer/Distributor)
42-
43-
Installer scripts are in `installer/`.
44-
45-
1. Stage files from manifest:
46-
47-
```powershell
48-
.\installer\stage_files_from_manifest.ps1
49-
```
50-
51-
1. Compile installer with Inno Setup script:
52-
53-
- `installer/gcbm_assistant_installer.iss`
54-
55-
1. Retrieve generated installer from:
56-
57-
- `installer/output/`
58-
59-
## Related References
60-
61-
- [Release and version policy](../operations/release-version-policy.md)
62-
- Installer implementation notes are maintained in `installer/README.md` in the
63-
repository root.
1+
# Installation Guide (Legacy)
2+
3+
This page contains installation details. Operational usage should follow the
4+
playbooks.
5+
6+
## Document Control
7+
8+
| Field | Value |
9+
| --- | --- |
10+
| Author | Geraldson Muluh |
11+
| Owner | GCBM Assistant maintainers |
12+
| Last reviewed | 2026-03-27 |
13+
| Review cadence | Monthly |
14+
15+
## Prerequisites
16+
17+
- Python `>=3.10`
18+
- `uv` (recommended) or `pip`
19+
- Windows installer users do not need local Python setup
20+
21+
## Source Installation
22+
23+
```bash
24+
git clone https://github.com/moja-global/gcbm_assistant.git
25+
cd gcbm_assistant
26+
uv pip install -e .
27+
gcbm-assistant
28+
```
29+
30+
Alternative launch:
31+
32+
```bash
33+
python -m gcbm_assistant.app
34+
```
35+
36+
## Windows Installer
37+
38+
1. Download the latest `GCBM_Assistant_Setup_*.exe`.
39+
1. Run the installer.
40+
1. Launch from desktop shortcut.
41+
42+
## Building the Installer (Developer/Distributor)
43+
44+
Installer scripts are in `installer/`.
45+
46+
1. Stage files from manifest:
47+
48+
```powershell
49+
.\installer\stage_files_from_manifest.ps1
50+
```
51+
52+
1. Compile installer with Inno Setup script:
53+
54+
- `installer/gcbm_assistant_installer.iss`
55+
56+
1. Retrieve generated installer from:
57+
58+
- `installer/output/`
59+
60+
## Related References
61+
62+
- [Release and version policy](../operations/release-version-policy.md)
63+
- Installer implementation notes are maintained in `installer/README.md` in the
64+
repository root.

0 commit comments

Comments
 (0)