doc: link Eliom with an odoc reference instead of a hardcoded URL#360
Merged
Conversation
The home page linked to Eliom's client/server HTML manual with a hardcoded https://ocsigen.org/eliom/latest/clientserver-html.html URL. Use the odoc cross-package reference {{!/eliom/page-clientserver-html}}; odoc resolves it on ocaml.org and wodoc rewrites it to Eliom's deployed docs on ocsigen.org via a new (hosted) entry.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Cross-project-links effort. The TyXML home page linked to Eliom's client/server HTML manual with a hardcoded
https://ocsigen.org/eliom/latest/clientserver-html.htmlURL (×2), which always sends the reader to ocsigen.org. Use the odoc cross-package reference{{!/eliom/page-clientserver-html}}: odoc resolves it to/p/eliomon ocaml.org and wodoc rewrites it to Eliom's deployed docs on ocsigen.org via a new(hosted (eliom eliom true Eliom))entry. Compiles withodoc compile.