chore: improve the api documentation and remove codecov

[evens-stone]

Description

Please provide a short summary of the changes you have made in this pull request. Include any context or background that might be helpful to reviewers.

Related Issue

Fixes # (issue number)

Type of Change

• Bug fix
• New feature
• Documentation update
• Refactoring
• Other (please describe):

Checklist (Preconditions for Code Review)

• Lint your code to ensure it adheres to the project's style guidelines.
• Run all existing and new unit tests locally to verify correctness.
• Ensure code changes are covered with appropriate tests (unit, integration, etc.).
• Update all dependencies to their latest compatible versions.
• Update documentation where necessary to reflect the changes.
• Resolve all linting and compilation errors.
• Follow SOLID principles and other best practices in the code.
• Review the code for potential security vulnerabilities.
• Add comments for complex or hard-to-understand parts of the code.
• Ensure the PR is appropriately scoped (small, focused, and easy to review).
• Ensure commit messages adhere to the Conventional commit message guidelines.
• Add tests for any new features or bug fixes.
• Clearly indicate if the pull request introduces any breaking changes.

Screenshots (if applicable)

Please add screenshots to help explain your changes if applicable.

Additional Information

Please provide any additional information that might be helpful during the review process.

[Copilot]

Pull Request Overview

This PR refines the API documentation by replacing redundant content with concise TypeScript code snippets and updates the README to remove Codecov references. Key changes include:

• Converting function documentation to standardized TypeScript code blocks.
• Removing source location metadata from the docs.
• Updating the CI pipeline by eliminating Codecov steps and badges.

Reviewed Changes

Copilot reviewed 201 out of 201 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
docs/HttpResponse/functions/*.md	Updated function documentation code snippets for HTTP response helpers.
docs/HttpErrorHandler/*.md	Revised documentation for error handler interfaces and classes with code block formatting.
docs/BinaryFileResponse/interfaces/BinaryFileResponseOptions.md	Converted property definitions to code blocks.
README.md	Updated badges and introductory text; removed Codecov badge.
.github/workflows/main.yml	Removed Codecov upload step from the CI workflow.

Comments suppressed due to low confidence (5)

docs/BinaryFileResponse/interfaces/BinaryFileResponseOptions.md:20

• Consider using standard TypeScript syntax for optional properties (e.g., 'autoEncoding?: boolean;') instead of using the 'optional' keyword.

optional autoEncoding: boolean;

docs/BinaryFileResponse/interfaces/BinaryFileResponseOptions.md:28

• Consider replacing 'optional autoEtag: boolean;' with 'autoEtag?: boolean;' to adhere to standard TypeScript optional property syntax.

optional autoEtag: boolean;

docs/BinaryFileResponse/interfaces/BinaryFileResponseOptions.md:36

• Replace 'optional autoLastModified: boolean;' with the standard 'autoLastModified?: boolean;' to improve clarity and correctness.

optional autoLastModified: boolean;

docs/BinaryFileResponse/interfaces/BinaryFileResponseOptions.md:44

• Consider using the syntax 'contentDispositionType?: string;' instead of 'optional contentDispositionType: string;' for consistency with TypeScript standards.

optional contentDispositionType: string;

docs/BinaryFileResponse/interfaces/BinaryFileResponseOptions.md:60

• Update 'optional headers: HeadersType;' to 'headers?: HeadersType;' to follow the conventional TypeScript syntax for optional properties.

optional headers: HeadersType;

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud