Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Connect multiple documentation sets together #2226

Open
mvriel opened this issue Jan 25, 2020 · 0 comments
Open

Connect multiple documentation sets together #2226

mvriel opened this issue Jan 25, 2020 · 0 comments

Comments

@mvriel
Copy link
Member

mvriel commented Jan 25, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
phpDoc issue triage board
  
Needs triage
Development

No branches or pull requests

1 participant