phpDocumentor / phpDocumentor/guides
How to deal with links to the code
Open
Nobody has claimed this yet.
feature
markdown
- Dominant language
- PHP
- Stars
- 36
- Forks
- 22
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 24
Description
Feature request
It seems to be quite common in Markdown to link to files that are not part of the actual documentation. The links can be outside of the root of the project like:
More information on running behaviour tests is available here: Behaviour tests
How should we deal with such links? Link them to Github?
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 how Markdown links are handled, using the example ../../Tests/Behavior/readme.md as the case to trace. Clarify whether links outside the documentation root should be rewritten to GitHub or handled another way, then define and test the agreed behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100