Skip to content

[Feature]: Create ARCHITECTURE.md documentation #1952

Open

Description

@rohitkumarnaidu

Feature description

Create an ARCHITECTURE.md file to document the high-level system design.

Problem it solves

New contributors often struggle to understand how different components of the system interact, leading to a steep learning curve and potential architectural anti-patterns in PRs.

Proposed solution

Adding a dedicated ARCHITECTURE.md file will map out the system's core modules, data flow, and key design decisions. I would love to draft this document! Could you assign this to me and add the ELUSOC label?

Alternatives considered

We could cram architectural details into the README, but keeping it in a separate file ensures the README remains clean and focused on onboarding.

Additional context

Thanks for the awesome project!

Activity

  1. github-actions commented on Aug 3, 2026

    @github-actions

    👋 Thanks for opening this issue! We appreciate your contribution. Please make sure you’ve provided all the necessary details and screenshots, and don't forget to follow our Guidelines and Code of Conduct. Happy coding! 🚀

  2. rohitkumarnaidu commented on Aug 3, 2026

    @rohitkumarnaidu
    Author

    Hi @maintainers,

    Following up on the bot's request for more details, here is the complete execution plan for setting up CODEOWNERS. Since this is a configuration feature, no screenshots are needed! 😅

    🛠️ Proposed Implementation Plan

    1. CODEOWNERS File Creation: Create a .github/CODEOWNERS file.
    2. Assigning Ownership:
      • Assign global repository ownership to the core maintainers (* @apu52).
      • Assign specific ownership (if applicable) for frontend/backend or documentation files to respective team members (e.g., /*.md @docs-team).
    3. Branch Protection Link: Ensure it integrates with GitHub's branch protection rules so that PRs cannot be merged without review from the assigned owners.

    This will instantly stream-line the PR review process and ensure no unreviewed code gets merged.

    Could you please assign this issue to me and add the ELUSOC label? I am ready to start working on this immediately! 🚀

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions