Skip to content

docs: Add ARCHITECTURE.md for codebase overview#6150

Draft
Srihari1192 wants to merge 1 commit intofeast-dev:masterfrom
Srihari1192:docs/architecture-documentation
Draft

docs: Add ARCHITECTURE.md for codebase overview#6150
Srihari1192 wants to merge 1 commit intofeast-dev:masterfrom
Srihari1192:docs/architecture-documentation

Conversation

@Srihari1192
Copy link
Contributor

@Srihari1192 Srihari1192 commented Mar 25, 2026

What this PR does / why we need it:

Add top-level ARCHITECTURE.md describing the Feast system design, component relationships, and codebase structure. Uses the existing architecture diagram from docs/assets/feast_marchitecture.png consistent with the README. Improves Architecture Documentation score in the AI Bug Automation Readiness report.

Which issue(s) this PR fixes:

Checks

  • I've made sure the tests are passing.
  • My commits are signed off (git commit -s)
  • My PR title follows conventional commits format

Testing Strategy

  • Unit tests
  • Integration tests
  • Manual tests
  • Testing is not required for this change

What ARCHITECTURE.md covers

  • System overview with existing architecture diagram
  • Component overview table (Registry, Provider, Offline/Online Store, Compute Engine)
  • Core concepts (Entity, FeatureView, FeatureService, DataSource, Permission)
  • Key abstractions with source file references
  • Feature Server endpoints
  • Permissions and authorization system
  • CLI commands
  • Kubernetes Operator structure
  • Directory structure map
  • Data flow diagrams (Training, Serving, Push-Based)
  • Extension points guide

Misc

  • 1 file added, 223 lines
  • References existing architecture image from docs/assets/

Copy link
Member

@franciscojavierarceo franciscojavierarceo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is missing feature transformation

Add top-level architecture document describing the Feast system
design, component relationships, and codebase structure. Uses the
existing architecture diagram from docs/assets/feast_marchitecture.png
consistent with the README.

Covers: system overview, core concepts, key abstractions, feature
server, permissions, CLI, Kubernetes operator, directory structure,
data flow diagrams, and extension points.

Co-Authored-By: Claude Opus 4.6 <[email protected]>
Signed-off-by: Ambient Code Bot <[email protected]>
@Srihari1192 Srihari1192 force-pushed the docs/architecture-documentation branch from 2fef7d9 to 43db26c Compare March 25, 2026 10:19
@Srihari1192 Srihari1192 changed the title docs: Add ARCHITECTURE.md and Architecture Decision Records docs: Add ARCHITECTURE.md for codebase overview Mar 25, 2026
Copy link
Member

@franciscojavierarceo franciscojavierarceo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Holding this, we already have our docs/ arch section. Having both feels excessive.

@Srihari1192
Copy link
Contributor Author

Holding this, we already have our docs/ arch section. Having both feels excessive.

Yes agree. This is the change added for improving ai-bug-automation-readiness score using Ambient.
Wondering if we add architecture.md file with feast architecture overview and point relevant docs link ?

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.

2 participants