php
PHP 2024 Documentation Roadmap
These are ideas that we want to achieve as part of @ThePHPF in 2024:
- [x] Constant linking (https://github.com/php/phd/pull/102, https://github.com/php/phd/pull/111
- [x] Improve call-out to contribute to the docs to be more like MDN which has it at the bottom of the page instead of hidden in the top right (https://github.com/php/web-php/pull/973)
- [x] Rewrite the "Edited-by" section of the documentation (https://github.com/php/doc-en/pull/3467 and https://github.com/php/doc-en/pull/3468)
- [x] Allow executing examples via 3v4l.org (in collaboration with @SjonHortensius) (https://github.com/php/doc-en/issues/3259)
- [ ] Investigate adding a "Last Edited" time for individual documentation pages (https://github.com/php/web-php/pull/977)
- [x] Triage user notes (Script to remove outdated and negatively voted notes is now live)
- [x] Implement a support policy for what PHP versions the documentation covers and for how long (#3700)
Making examples executable would ideally be done by storing the correct script link somewhere. Alternatively a new POST could be done to the correct endpoint containing the full example code - 3v4l will then forward the user to the correct script. I'd be happy to help with supporting the implementation from the 3v4l side
I think there will need to be some changes in PhD to tie the example content to the output box if it exists, we might also need to limit it to parts of the documentation that does not refer to PECL extensions, as I don't think those are on 3v4l?
Is there any plan to split these points into separate issues with better guidance to contributors on what needs to be done? Or is this just an announcement of what kind of work is already being carried out?
We can split them up into separate issues, the constant linking one is more or less "done" as there has been good progress on this. User notes is something where one needs access to the underlying database so difficult to contribute.
The rest could be their own issues
Folks, I've created a #3259 to continue "Allow executing examples via 3v4l.org" implementation discussion.
@Girgias What does "Constant linking" exactly mean? Is it that the constants which are documented somewhere else than "predefined constant" pages should be moved to one of these pages and they should be linked wherever they are referenced from? Is documenting the rest of the missing constants/functions/methods too big of a project?
@Girgias What does "Constant linking" exactly mean? Is it that the constants which are documented somewhere else than "predefined constant" pages should be moved to one of these pages and they should be linked wherever they are referenced from? Is documenting the rest of the missing constants/functions/methods too big of a project?
It's just to have <constant> tags create a link to the constant definition, similarly to how <function> does this for functions. It might require moving constants to the more standard pages, but not necessarilly.
* [ ] Rewrite the "Edited-by" section of the documentation
Do https://github.com/php/doc-en/pull/3467 and https://github.com/php/doc-en/pull/3468 address this in part or whole?
* [ ] Implement a support policy for what PHP versions the documentation covers and for how long
This item is addressed by the following PR: https://github.com/php/doc-en/pull/3700