This repository contains the public API documentation for the Omega Framework, generated using phpDocumentor. It serves as a comprehensive guide to all the available classes, methods, functions, and other API components within the Omega Framework. The documentation provides detailed information about the framework's core functionality, usage examples, and integration guidelines, making it a valuable resource for developers building applications with Omega.
The main goal of this repository is to provide an up-to-date and accurate reference for developers using the Omega Framework. As Omega evolves, so does its documentation. Any changes made to the core libraries, the framework's structure, or its configuration options will be reflected here to ensure that developers always have access to the latest information.
This repository also includes updates to the documentation theme. The theme changes might involve improvements to the visual appearance, new sections, and adjustments that enhance readability or accessibility. These changes are made to ensure that the documentation remains clean, easy to navigate, and aligned with the overall framework's vision.
With each release of the Omega Framework, this repository is updated to reflect any changes made to the framework’s API or underlying architecture. Key updates typically include:
- New Features: Documentation for any new classes, methods, or functionality added to the framework.
- Deprecated Methods: Information on any deprecated methods or features that will be removed in future releases.
- Bug Fixes and Enhancements: Details on fixes and improvements made to the framework, which may affect existing functionality or introduce new best practices.
- Documentation Theme Updates: Adjustments to the look and feel of the documentation, improving navigation, searchability, and user experience.
As Omega is actively developed, keeping the API documentation up to date is a priority. You can find the full changelog of updates to the API documentation and the Omega Framework in the section below.
By following the changelog, you will always be able to track the changes and improvements made to both the framework and its API documentation.
Expand for reading the complete changelog
2024-12-07
- Adding class diagram to documentation
2024-12-05
- Omega: Update composer schema in composer.json
- Framework: Update composer schema in composer.json
2024-12-04
- Omega: Update .gitignore
- Omega: Remove CHANGELOG.md
- Omega: Update README.md
- Framework: Remove CHANGELOG.md
- Framework: Update README.md
- Framework: Fix grammar issue in Application.php
- Framework: Fix grammar issue in RuleInterface.php
- Documentation: Regenerate API.
Changelog Update
The changelogs previously maintained in the omega and framework repositories have been removed. From now on, all updates, modifications, and release notes are consolidated and maintained in the central changelog available within the official Omega documentation.
This change ensures consistency and provides a single, authoritative source for tracking the evolution of the framework and its ecosystem.
If you have any questions or concerns, feel free to open an issue or reach out via the official communication channels.
2024-12-03
- Omega: Initial Release
- Framework: Initial Release
We welcome contributions from the community! If you’d like to contribute to the documentation or have suggestions for improving the API references, please feel free to submit a pull request. For more details, refer to the contributing guidelines.