Skip to content

README project structure is out of sync with repository contents #39

@kmuwanga83

Description

@kmuwanga83

📌 Problem

The README describes a project structure that includes a greencode-frontend/ directory. However, this folder is not visible in the repository.

This creates confusion for new contributors trying to understand the system architecture and setup.

🎯 Objective

Ensure that the README accurately reflects the current repository structure.

✅ Tasks

  • Review the current repository file structure
  • Update the README "Project Structure" section
  • Remove or clarify references to missing folders
  • Indicate whether the frontend:
    • exists in another repository
    • exists in another branch
    • is still under development

🧪 Acceptance Criteria

  • README structure matches actual repo contents
  • No references to non-existent folders
  • Clear explanation of frontend location/status

💡 Suggested Labels

documentation, good first issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions