Skip to content

Commit 1177a83

Browse files
committed
updated docs, added function index
1 parent b592e73 commit 1177a83

10 files changed

Lines changed: 1172 additions & 5 deletions

CHANGELOG.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
# Changelog
22
---
33

4+
## [2.9.1] - 2026-02-28
5+
6+
### Added
7+
- **Function index generator**: Added `scripts/generate-function-index.py` to auto-generate `docs/FUNCTION_INDEX.generated.md` from runtime source function declarations.
8+
- **Generated function inventory**: Added `docs/FUNCTION_INDEX.generated.md` as a machine-generated reference for maintainers.
9+
10+
### Changed
11+
- **Updated Documentation**: `DOCUMENTATION.md` has been simplified & updated to v2.9.0.
12+
- **Documentation cross-linking**: Added references to curated and generated function indexes in `README.md` and `DOCUMENTATION.md`.
13+
- **Release regeneration workflow**: `scripts/regenerate-release.sh` now regenerates `docs/FUNCTION_INDEX.generated.md` before rebuilding `release/` artifacts.
14+
415
## [2.9.0] - 2026-02-22
516

617
### Added
@@ -815,7 +826,7 @@ handleDrop(event, phaseKey) // Performs assignment
815826

816827
---
817828

818-
## Development Notes for AI Agents
829+
## Development Notes
819830

820831
### File Structure Understanding
821832
```

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ Contributions are welcome. Please read the following guidelines before submittin
2626
- Follow existing code style and naming conventions
2727
- Keep functions focused and well-documented
2828
- Test drag-and-drop, import/export, and metadata editing
29+
- Keep docs in sync with shipped behavior:
30+
- Update `CHANGELOG.md` for user-visible and security-relevant changes
31+
- Update `README.md` when setup, usage, or feature surface changes
32+
- Update `DOCUMENTATION.md` for architecture/runtime behavior changes
33+
- Update `docs/FUNCTION_INDEX.md` and regenerate `docs/FUNCTION_INDEX.generated.md` when function surfaces change
2934

3035
## Data Updates
3136

DOCUMENTATION.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -549,4 +549,21 @@ Suggested split of current monolith:
549549

550550
---
551551

552+
## 11. Function Index Reference
553+
554+
For a comprehensive, maintainable function inventory (grouped by file and subsystem), see:
555+
556+
- **`docs/FUNCTION_INDEX.md`**
557+
- **`docs/FUNCTION_INDEX.generated.md`** (auto-generated inventory)
558+
559+
This index is intentionally line-agnostic to reduce churn while remaining onboarding-friendly for maintainers.
560+
561+
Refresh generated index with:
562+
563+
```bash
564+
python3 scripts/generate-function-index.py
565+
```
566+
567+
---
568+
552569
*Generated for AttackFlow v2.9.0 from current workspace sources (`index.html`, `config.js`, `stix-config.js`, `docs/IPC_API-DOCS.md`).*

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ An editor for creating enriched Cyber Kill Chain assessments by mapping MITRE AT
44

55
### Work in progress
66

7-
![Version](https://img.shields.io/badge/version-2.9.0-blue)
7+
![Version](https://img.shields.io/badge/version-2.9.1-blue)
88
[![MITRE ATT&CK® 18](https://img.shields.io/badge/MITRE%20ATT%26CK®-v18-red)](https://attack.mitre.org/versions/v18/)
99
![License](https://img.shields.io/badge/license-Apache%202.0-green)
1010
![Dependencies](https://img.shields.io/badge/dependencies-none-brightgreen)
@@ -233,6 +233,10 @@ Configuration in `config.js`:
233233

234234
See [IPC API DOCS](docs/IPC_API-DOCS.md) for concise architecture and threat-model documentation.
235235

236+
For a complete maintainer-oriented function inventory across runtime files, see [Function Index](docs/FUNCTION_INDEX.md).
237+
238+
For the auto-generated declaration inventory, see [Generated Function Index](docs/FUNCTION_INDEX.generated.md).
239+
236240
### STIX Visualizer Toggle
237241

238242
The integrated STIX visualizer can be fully disabled via config:

config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
const CONFIG = {
99
// Application info
10-
version: '2.9.0',
10+
version: '2.9.1',
1111
changelogUrl: 'CHANGELOG.md',
1212

1313
// Framework source files (for extraction scripts)

docs/FUNCTION_INDEX.generated.md

Lines changed: 441 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)