Skip to content

[DOCS] Add Project Documentation Under docs/ #18

@HarshYadav152

Description

@HarshYadav152

The project needs structured documentation to improve contributor onboarding, project understanding, and development workflow.

This issue focuses on creating and organizing documentation files inside the docs/ directory.


Tasks

  • Create a docs/ directory
  • Add setup and installation documentation
  • Add project architecture overview
  • Add API/authentication documentation (if applicable)
  • Add contribution guidelines
  • Add folder structure explanation
  • Add deployment instructions
  • Improve formatting and readability

Suggested Documentation Structure

docs/
├── installation.md
├── architecture.md
├── contribution-guide.md
├── deployment.md
├── api.md
└── folder-structure.md

Requirements

  • Documentation should be beginner-friendly
  • Use proper Markdown formatting
  • Include code snippets/examples where necessary
  • Maintain consistent headings and structure
  • Ensure all information is accurate and updated

Acceptance Criteria

  • All documentation files are added under docs/
  • Markdown files are properly formatted
  • Instructions are clear and easy to follow
  • Documentation matches the current project structure
  • No broken links or outdated information

Metadata

Metadata

Labels

ELUSOCProject Issue registered under EduLinkUp Summer of CodeNEWBIEIntermediate tasks that add features, fix bugs, improve APIs, or major documentation.documentationImprovements or additions to documentationeasygood first issueGood for newcomers

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions