Commit f446847
committed
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.1 parent 5b9cfec commit f446847
2 files changed
+20
-14
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
67 | 67 | | |
68 | 68 | | |
69 | 69 | | |
70 | | - | |
71 | 70 | | |
72 | 71 | | |
73 | | - | |
74 | 72 | | |
75 | 73 | | |
76 | 74 | | |
77 | 75 | | |
78 | | - | |
79 | 76 | | |
80 | 77 | | |
81 | 78 | | |
| |||
85 | 82 | | |
86 | 83 | | |
87 | 84 | | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
88 | 94 | | |
89 | 95 | | |
90 | 96 | | |
| |||
333 | 339 | | |
334 | 340 | | |
335 | 341 | | |
336 | | - | |
337 | | - | |
338 | | - | |
339 | | - | |
340 | | - | |
341 | | - | |
342 | | - | |
343 | | - | |
344 | | - | |
345 | | - | |
346 | 342 | | |
347 | 343 | | |
348 | 344 | | |
| |||
354 | 350 | | |
355 | 351 | | |
356 | 352 | | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| 360 | + | |
357 | 361 | | |
358 | 362 | | |
359 | 363 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
389 | 389 | | |
390 | 390 | | |
391 | 391 | | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
392 | 395 | | |
393 | 396 | | |
394 | | - | |
395 | 397 | | |
396 | 398 | | |
397 | 399 | | |
| |||
0 commit comments