Azure / Azure/git-ape

Living documentation pipeline with auto-refresh and drift detection

Open
#26 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
JavaScript
Stars
269
Forks
45
Avg merge
18h 41m
Merged PRs (30d)
11

Description

## Description

The manifesto lists "living documentation" as a capability modules could never provide. Git-ape generates architecture diagrams but does not maintain them as living artifacts that auto-update with infrastructure changes.

## Scope

1. **Auto-regeneration** — After any deployment change, re-run the resource visualizer and update `architecture.md`.
2. **Dependency graph** — Generate dependency graphs showing relationships between deployments.
3. **Documentation drift** — Detect when `architecture.md` diverges from actual deployed state.
4. **Changelog** — Auto-generate a changelog from deployment history (`state.json` changes).

## Acceptance Criteria

- [ ] Architecture diagrams auto-update on infrastructure changes.
- [ ] Dependency graphs show cross-deployment relationships.
- [ ] Documentation drift is detected and flagged.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.