PHP 2024 Documentation Roadmap
Open
Nobody has claimed this yet.
- Dominant language
- XML
- Stars
- 596
- Forks
- 890
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 55
Description
These are ideas that we want to achieve as part of @ThePHPF in 2024:
- Constant linking (https://github.com/php/phd/pull/102, https://github.com/php/phd/pull/111
- 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)
- 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)
- 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)
- Triage user notes (Script to remove outdated and negatively voted notes is now live)
- Implement a support policy for what PHP versions the documentation covers and for how long (#3700)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the remaining unchecked item about adding a “Last Edited” time for individual documentation pages and the linked web-php pull request #977. Determine what page information is available there; done means documenting or implementing a clear last-edited time for individual pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100