You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add missing documentation commands and shell access to Makefile and README
This comprehensive update enhances the Makefile and README with missing
functionality and documentation:
1. Add new API documentation workflow commands:
- 'apidocs-serve' to start a web server for viewing documentation
- 'apidocs' to both generate and serve documentation in one step
2. Add container shell access command:
- 'php-connect' to provide an interactive shell within the PHP container
- Properly handle running container checks and user feedback
3. Update the help command in Makefile with:
- New documentation section listing all API documentation commands
- Container access section for the shell access commands
- Description for 'composer-script' showing usage with arguments
4. Update README command table:
- Replace deprecated 'apidoc' with 'apidocs-generate'
- Add the new 'apidocs-serve' and 'apidocs' commands
- Add 'php-connect' command with description
- Ensure all command descriptions are clear and consistent
These additions provide developers with more flexible options for generating
and accessing API documentation, as well as improved direct access to the
containerized environment for debugging and maintenance tasks.
0 commit comments