META¶
Introduction¶
This document explains how Renderflow's architecture documentation is organized, how the documents relate to one another, and how the knowledge base should remain coherent over time.
Conformance¶
This document is authored in conformance with:
.github/specs/architecture/document.spec.md.github/specs/architecture/meta/meta.spec.md
Purpose & Scope¶
This document describes the architecture framework itself.
It covers architectural layers, document relationships, canonical ownership, reading order, and evolution guidance. It does not restate the content of each document or replace project architecture.
Definitions¶
- Architecture framework: the full collection of architecture documents.
- Layer: a logical grouping of documents with similar concern type.
- Canonical owner: the one document responsible for a specific concern.
- Dependency graph: the directed relationships among architecture documents.
Architecture Framework¶
Layer model¶
Renderflow's architecture knowledge base is organized into six layers:
- Identity — why Renderflow exists and the beliefs guiding it.
- Foundation — how Renderflow works conceptually and how it should evolve structurally.
- Domain — the vocabulary and human model needed to reason about the project.
- Governance — the memory of important accepted decisions.
- Experience — the desired user experience and the reusable language that expresses it.
- Meta — governance for AI participation, knowledge evaluation, and the architecture framework itself.
Canonical ownership¶
PURPOSE.mdowns reason for existence.VISION.mdowns the future state.MANIFESTO.mdowns beliefs.PRINCIPLES.mdowns decision rules.PILLARS.mdowns enduring capability areas.METHODOLOGY.mdowns how work should be performed.FOUNDATIONS.mdowns stable architectural assumptions.ONTOLOGY.mdowns vocabulary.PERSONAL_MODEL.mdowns assumptions about people.SYSTEM.mdowns major systems and capability boundaries.ARCHITECTURE.mdowns structural organization and dependency direction.DESIGN.mdowns design philosophy.DESIGN_SYSTEM.mdowns reusable design language.ROADMAP.mdowns strategic evolution.DECISIONS.mdowns accepted historical decisions.AI_CONSTITUTION.mdowns AI governance.EPISTEMOLOGY.mdowns knowledge philosophy.META.mdowns the architecture framework itself.
Reading order¶
The intended dependency flow is:
PURPOSE
↓
VISION
↓
MANIFESTO
↓
PRINCIPLES
↓
PILLARS
↓
METHODOLOGY
↓
FOUNDATIONS
↓
ONTOLOGY
↓
SYSTEM
↓
ARCHITECTURE
↓
DESIGN
↓
DESIGN_SYSTEM
↓
ROADMAP
DECISIONS, AI_CONSTITUTION, and EPISTEMOLOGY are cross-cutting governance
views that depend on the upstream architecture while informing future work.
Evolution rules¶
- Add a new architecture document only when an existing canonical owner cannot responsibly contain the concern.
- Update dependencies when document relationships change.
- Prefer refining one canonical document over duplicating the same concept elsewhere.
- Keep implementation views separate from canonical architecture knowledge.
Requirements, Constraints & Guidelines¶
Requirements¶
- Layers and document relationships must be explicit.
- Canonical ownership must remain clear.
- The dependency graph must be understandable to humans and AI systems.
Constraints¶
- This document must not duplicate the content of downstream documents.
- Implementation details must stay out of the architecture framework description.
- Project-specific engineering guidance must not replace architectural navigation.
Guidelines¶
- Explain relationships rather than content.
- Favor conceptual clarity over exhaustive repetition.
- Treat the architecture itself as a maintained system.
Authoring Contract¶
Purpose¶
Own the organization and maintenance model of the architecture knowledge base.
Responsibilities¶
This document owns:
- architecture layering,
- document relationships,
- canonical ownership,
- navigation guidance,
- evolution rules.
Non-Responsibilities¶
This document does not own:
- project purpose,
- system design,
- methodology detail,
- implementation guidance.
Inputs¶
- every architecture document
- the architecture specifications
- dependency relationships among documents
Outputs¶
- contributor onboarding
- AI architecture generation
- architecture maintenance practice
- future architecture evolution
AI Generation Rules¶
AI systems should map the architecture framework, preserve canonical ownership, and avoid restating document contents.
Validation¶
A new contributor should be able to understand how to navigate the architecture before reading every individual file.
Acceptance Criteria¶
- Architecture layers are documented.
- Document relationships and ownership are explicit.
- Dependency flow is understandable.
- The framework can evolve without losing coherence.
AI Authoring Strategy¶
AI systems should:
- read every architecture document,
- identify layers and ownership,
- map dependency flow,
- explain navigation and evolution,
- avoid duplicating individual documents.
Rationale & Context¶
Renderflow now contains a deliberate architecture knowledge base rather than a
small set of isolated implementation notes. META.md prevents that knowledge
base from becoming another undocumented system by making ownership, layering,
and reading order explicit.
Dependencies & External Integrations¶
Upstream Dependencies¶
- every architecture document
Downstream Dependencies¶
- contributor onboarding
- AI architecture generation
- documentation maintenance
- architecture evolution
Examples & Edge Cases¶
Example¶
A contributor looking for the meaning of "Execution Plan" should go to
ONTOLOGY.md, while a contributor asking how plans relate to layers should go to
ARCHITECTURE.md.
Edge Case¶
If a new document about policy or reliability is added, META.md must be
updated to explain where it sits in the architecture framework and what concern
it canonically owns.
Validation Criteria¶
This document is valid when contributors can navigate the architecture system without guessing where a concept belongs.
Related Specifications¶
.github/specs/architecture/document.spec.md.github/specs/architecture/meta/meta.spec.md