phpDocumentor / phpDocumentor/phpDocumentor
Connect multiple documentation sets together
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 4.3k
- Forks
- 648
- Avg merge
- 28m
- Merged PRs (30d)
- 13
Description
For release 3.1 or later, we are considering adding support for connecting multiple sets of documentation together. This means that if a library were to use phpDocumentor, that you can link that documentation to yours and whenever your documentation references a class in their project; a link would be made to that documentation site.
I want to gather more information, such as how to define such links, before starting an implementation. Two options I can think of already is to generate an XML index / sitemap to which you can refer your project to, or to define the links in your own project (but this is more cumbersome as the consuming project needs to maintain the links)
More input is appreciated during this RFC / Research phase.
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
No implementation files, tests, or entry points are named. Start by comparing the two proposed approaches: an XML index or sitemap referenced by projects, and links defined by the consuming project. Done for this research phase would be a documented recommendation for how cross-project documentation links should be defined and maintained.
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
- 20/100