phpDocumentor / phpDocumentor/guides
Restructure image target node
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 36
- Forks
- 22
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 24
Description
Feature request
In #914 the image target was added, but rather than adding a new node to the image as target it would make more sense to wrap the image node in a link node like a decoration on the image node.
To do this we need to change the hyperlink nodes to a compound version that will allow us to make a more complex node structure. We consider this a BC break as template authors need to update their templates. Therefor this has been scheduled for v2.0.0 of this library.
Contributor guide
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 image target added in #914 and the existing hyperlink node implementation. Determine how a compound hyperlink can wrap an image as a decoration, then identify the affected template structures and the v2.0.0 compatibility changes. Done means image targets use the new wrapped structure and template authors have a clear migration path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100