documentations/ciq_3g_doc.py

import streamlit as st

st.markdown(
    """
# CIQ 3G Generator Documentation

## 1. Objective
Generate 3G CIQ outputs (WBTS/WCEL) from a raw CIQ Excel file.

## 2. When to use this tool
Use this page when building 3G CIQ outputs with naming and band conventions.

## 3. Input files and accepted formats
- Required: CIQ brut 3G file (`.xlsx` or `.xls`)

## 4. Required columns/fields
Required structure must match expectations of the 3G processing pipeline.
User-configurable inputs:
- `Year suffix` (default: `26`)
- `Bands string` (default: `G9G18U9U21L8L18L26`)

## 5. Step-by-step usage
1. Open `Apps > CIQ 3G Generator`.
2. Upload CIQ brut 3G Excel file.
3. Set `Year suffix` and `Bands string` if needed.
4. Click `Generate`.
5. Review generated sheets.
6. Download final workbook.

## 6. Outputs generated
- in-app tabs for generated sheets
- downloadable workbook `CIQ_3G.xlsx`

## 7. Frequent errors and fixes
- Missing input file.
  - Fix: upload `.xlsx`/`.xls` CIQ 3G file.
- Generation error.
  - Fix: verify CIQ template structure and required columns.
- Unexpected naming output.
  - Fix: validate `Year suffix` and `Bands string` values.

## 8. Minimal reproducible example
- Input: `samples/CIQ_3G.xlsx`
- Action: keep defaults and click `Generate`.
- Expected result: populated sheets and downloadable `CIQ_3G.xlsx`.

## 9. Known limitations
- Output quality depends on CIQ raw file quality.
- Custom naming conventions require correct user parameters.
- Schema deviations can break generation.

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