[Docs | API] Improve and Update Documentation

[AbreuHD]

The goal of this issue is to improve and update the API documentation to ensure clarity, accuracy, and completeness. The documentation should provide comprehensive information for developers and stakeholders, following industry best practices.

Tasks to be completed

• Review the existing documentation for completeness and correctness.
• Update outdated or incorrect information.
• Improve structure and formatting for better readability.
• Add missing sections such as:
  • API endpoints with detailed request/response examples.
  • Explanation of authentication and authorization mechanisms.
  • Common error handling and troubleshooting guidelines.
  • Environment setup and deployment instructions.
• Ensure consistency across all documentation files.
• Validate documentation usability by gathering feedback from team members.

Acceptance criteria

• Documentation must be clear, concise, and easy to understand.
• All API endpoints should have well-documented examples.
• The documentation should follow a consistent structure and formatting style.
• A changelog should be included with major updates made.