NexGenStudioDev / NexGenStudioDev/CommDesk-Website

docs: add architecture and application flow diagrams to README

Open
#19 2 comments 0 reactions 1 assignee View on GitHub

@molathotisaiteja1267-ctrl is already working on this.

Since Jul 25, 2026.

Dominant language
TypeScript
Stars
1
Forks
8
PR merge metrics
No merged PRs in 30d

Description

Description

Problem

The README explains the project's feature-based architecture and folder structure, but it lacks visual diagrams illustrating how the application's modules interact. New contributors must infer the relationships between pages, components, feature modules, state management, services, and API layers.

Proposed Solution

Add an Architecture section to the README containing:

  • High-level application architecture diagram
  • Request flow diagram (UI → Feature → Store → Service → API)
  • Feature module organization diagram
  • State management flow
  • Brief explanation accompanying each diagram
Benefits
  • Improves onboarding for first-time contributors.
  • Makes the feature-based architecture easier to understand.
  • Reduces time spent exploring the codebase.
  • Serves as a quick reference for future contributors.
Additional note

Hello mentor! I am GSSOC'26 contributor and if this issue aligns with the project requirements,kindly assign this to me.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.