documentations/ciq_verification_doc.py

import streamlit as st

st.markdown(
    """
# CIQ Verification Documentation

## 1. Objective
Verify CIQ parameter values against the OML dump database for 2G, 3G, and LTE.

## 2. When to use this tool
Use this page before integration/deployment to quickly detect:
- parameter mismatches
- missing references in dump
- per-technology CIQ consistency issues

## 3. Input files and accepted formats
- Required: dump file in `.xlsb`
- Optional CIQ files: `.xlsx` or `.xls`
  - CIQ 2G
  - CIQ 3G
  - CIQ LTE
- Rule: at least one CIQ file must be uploaded.

## 4. Required fields and structure
- Dump and CIQ files must contain expected network parameter columns used by verification functions.
- Each technology is processed independently when its CIQ file is provided.

## 5. Step-by-step usage
1. Open `Apps > CIQ Verification`.
2. Upload dump `.xlsb`.
3. Upload one or more CIQ files (2G/3G/LTE).
4. Click `Verifier`.
5. Review per-technology metrics (`OK`, `Mismatch`, `Not Found`).
6. Download the Excel verification report.

## 6. Outputs generated
- tabbed result tables per technology
- summary metrics for each processed technology
- downloadable Excel report: `CIQ_Verification_Report.xlsx`

## 7. Frequent errors and fixes
- Message: dump is required.
  - Fix: upload `.xlsb` before running verification.
- Message: at least one CIQ file required.
  - Fix: upload at least one CIQ 2G/3G/LTE file.
- Runtime verification error.
  - Fix: validate CIQ headers and sheet integrity.

## 8. Minimal reproducible example
- Input: one dump `.xlsb` + one CIQ LTE `.xlsx`.
- Action: click `Verifier`.
- Expected result: LTE tab with status highlights + Excel report button.

## 9. Known limitations
- Verification quality depends on CIQ template consistency.
- Mixed naming standards can produce `NOT_FOUND` results.
- Processing large files may take noticeable time.

## 10. Version and update date
- Documentation version: 1.0
- Last update: 2026-02-23
"""
)