cakephp / cakephp/cakephp-api-docs
API Docs Links appear broken
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 29
- Forks
- 15
- PR merge metrics
- No merged PRs in 30d
Description
Description
Viewing API Documentation on the web, e.g. RecordNotFoundException, shows the raw link string instead of an actual hyperlink, e.g.:
Array of headers to be passed to {@link \Cake\Http\Response::withHeader()}
It doesn't seem that the files containing the links are the issue, e.g. CakeException.php hasn't changed in ~two years, perhaps the docs builder/link generator has started failing?
CakePHP Version
4.4.0
PHP Version
No response
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
Compare the generated RecordNotFoundException API page with the source reference in CakeException.php, especially the {@link \Cake\Http\Response::withHeader()} text. Trace the docs builder or link generator responsible for converting these references, then verify that the generated API documentation renders them as hyperlinks rather than raw strings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100