# Status

**Project:** code-docgen  
**Version:** 1.0.0  
**Path:** `/Users/rbutare/websites/apps/docgen`  
**Updated:** 2026-08-23

## Overall

| Area | State |
|------|--------|
| Core generator (`docgen.py`) | Done |
| Language extractors (py/js/php/sh/css/sql/html) | Done |
| Markdown + HTML renderers | Done |
| Bootstrap installer (`install.sh`) | Done |
| Local binary installer (`install-local.sh`) | Done |
| Test harness (`test.sh`) | Done |
| Example sources | Done |
| README / STATUS / TASKS / FAQ | Done |

## Working

- Version detection from common header patterns
- Purpose from module docstrings, block comments, HTML title/meta
- Function/method extraction with sample usage hints
- CSS variables & selectors; SQL tables/procs; HTML forms/scripts
- End-to-end test: install → generate → assert markers

## Known limitations

- Regex-based (not full AST) — complex nested constructs may be missed
- JS purpose attachment can pick up adjacent docblocks
- Shell params are positional (`$1`…) — not inferred from body
- No TypeScript / JSX / Vue SFC support yet
- HTML renderer is a lightweight MD→HTML conversion

## Test status

```text
bash test.sh  →  All checks passed
```