Skip to content

docs: add architecture overview, release process, and design documents#133

Merged
creydr merged 1 commit into
functions-dev:mainfrom
creydr:docs/architecture-and-release-process
May 11, 2026
Merged

docs: add architecture overview, release process, and design documents#133
creydr merged 1 commit into
functions-dev:mainfrom
creydr:docs/architecture-and-release-process

Conversation

@creydr
Copy link
Copy Markdown
Collaborator

@creydr creydr commented May 11, 2026

Summary

  • Add docs/architecture.md with component overview, CRD lifecycle, reconciliation flow (Mermaid diagram), and conditions model
  • Add docs/release.md documenting the branching model, automated tag management, patch/minor/emergency release process
  • Commit 7 historical design documents (docs/plans/*-design.md) capturing rationale and tradeoffs for past decisions
  • Update AGENTS.md and CONTRIBUTING.md with links to the new documentation

This is aimed at helping new maintainers (and their AI assistants) get up to speed quickly.

Add documentation to help new maintainers understand the system:
- docs/architecture.md: component overview, CRD lifecycle, reconciliation
  flow diagram, conditions model
- docs/release.md: branching model, automated tag management, patch/minor
  release process
- docs/plans/*-design.md: historical design documents capturing rationale
  and tradeoffs for past decisions

Update AGENTS.md and CONTRIBUTING.md with links to the new docs.
@creydr creydr enabled auto-merge May 11, 2026 11:12
@creydr creydr added this pull request to the merge queue May 11, 2026
Merged via the queue into functions-dev:main with commit 833b538 May 11, 2026
21 of 23 checks passed
@creydr creydr deleted the docs/architecture-and-release-process branch May 11, 2026 14:05
@creydr
Copy link
Copy Markdown
Collaborator Author

creydr commented May 12, 2026

/cherry-pick release-0.3

@functions-dev-ci-bot
Copy link
Copy Markdown

Successfully created cherry-pick PR for release-0.3:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant