Skip to content

adding docs to the project

Hari Kumar Gokavarapu requested to merge fix/hari into main

Documentation Updates

Summary

This merge request adds and updates project documentation to improve onboarding, contribution workflow, and overall project usability.

Changes Made

  • Added CONTRIBUTING.md with contribution guidelines and development workflow.
  • Updated README.md with improved project overview, setup instructions, and usage information.
  • Added AGENTS.md documenting project agents, responsibilities, and architecture details.
  • Added USER_MANUAL.md providing end-user instructions and feature walkthroughs.

Purpose

These documentation improvements aim to:

  • Simplify onboarding for new contributors.
  • Standardize the contribution process.
  • Provide clear guidance for developers and users.
  • Improve project maintainability and collaboration.

Testing

  • Verified all markdown files render correctly.
  • Checked internal links and document structure.
  • Reviewed content for clarity and consistency.

Additional Notes

No source code changes were made. This merge request contains documentation updates only.

Merge request reports

Loading