Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign up[Help Wanted] API Documentation Improvements #3520
Open
Projects
Comments
|
This issue will be closed and archived in 3 days, as there has been no activity in the last 30 days. If this issue is still relevant or you would like to see action on it, please respond and we will get the ball rolling. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The OctoberCMS auto-generated API documentation is quite nice, but there's always room for improvements. If you come across any docblocks in core October files that could be improved, updated, or even just added in the first place, PRs to the respective repositories would be much appreciated.
Additionally, it would be very helpful to get full inline documentation of all the available events. See ac2e593#diff-1420ca0ddf5e739c2d05c7834b1df8e4 for an example of how to structure said inline documentation and see https://docs.google.com/spreadsheets/d/17vv4zn_ezp9iFBgYhYuYsmUG4MXW9uuIw7aOIrVcHiM/edit?usp=drive_web&ouid=113029731553033353279 for a mostly complete listing of events available within OctoberCMS.