Skip to content

[Docs]: Update README.md to reflect the latest backend folder structure #382

Description

@AnandAyush005

Documentation Section

README.md

Current Issue

The backend project structure documented in README.md is outdated. Since the backend has been updated, new directories such as input_validations and their associated files (e.g., index/initialization files) have been introduced. However, these additions are not reflected in the current project structure shown in the README, which can cause confusion for contributors and new developers.

Suggested Changes

  • Update the backend folder structure in README.md to match the current project layout.
  • Include the newly added input_validations directory and its relevant files.
  • Verify that all other recently added folders and files are also represented accurately.
  • Review the documentation periodically to keep it synchronized with the codebase.

Benefits

  • Ensures the documentation accurately represents the current backend architecture.
  • Makes onboarding easier for new contributors by providing an up-to-date project structure.
  • Reduces confusion when navigating the repository.
  • Improves overall project maintainability by keeping documentation in sync with implementation.

References / Examples

No response

Checklist

  • I have checked that this documentation issue has not already been reported.
  • I am willing to contribute the documentation update myself.

Metadata

Metadata

Assignees

Labels

ECSoC26documentationImprovements or additions to documentation

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions