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

Add Interlink json #619

Open
jaapio opened this issue Sep 28, 2024 · 1 comment
Open

Add Interlink json #619

jaapio opened this issue Sep 28, 2024 · 1 comment

Comments

@jaapio
Copy link
Contributor

jaapio commented Sep 28, 2024

Other projects using doctrine can be able to link to the interlink index if doctrine would provide this in there documentation. In phpDocumentor guides we implemented the format that is defined by sphinx to create links between documentation sets. The main advantage over hard links to specific pages is that you can link to anchors set by the writers of the external documentation. This will work even if the section is moved to another page and will just require rerendering when links are broken. The interlink format can be used by doctrine documentation itself as well to link between projects. No more hard links between dbal and ORM or ORM and collections.

To support this for doctrine we just need to enable that theme in the documentation rendering, which can be done next to the doctrine theme. It doesn't require any extra work on the documentation itself.

Examples can be found here: https://github.com/phpDocumentor/guides/tree/main/tests/Integration/tests/interlink

I'm willing to create a PR for this feature.

@greg0ire
Copy link
Member

I think it could indeed be useful, we do have a few of those links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants