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

stable manual links #5701

Closed
vicuna opened this issue Jul 26, 2012 · 2 comments
Closed

stable manual links #5701

vicuna opened this issue Jul 26, 2012 · 2 comments

Comments

@vicuna
Copy link

vicuna commented Jul 26, 2012

Original bug ID: 5701
Reporter: @ygrek
Assigned to: @damiendoligez
Status: closed (set by @damiendoligez on 2012-07-31T15:31:36Z)
Resolution: fixed
Priority: normal
Severity: feature
Version: 4.00.0
Category: web site
Monitored by: @hcarty

Bug description

Consider the situation when one wants to link to the official manual for the current release. It is available at the following url : http://caml.inria.fr/pub/docs/manual-ocaml/ but the problem is that after the next release this link will serve the manual for the new version and the old link becomes broken (section numbers are not stable). The old manual meanwhile becomes available at e.g. manual-ocaml-312. Hence the feature wish is to create such manual-ocaml-xxx directories (for the latest xxx version) at the time of release so that one can get future-proof links for now-current documentation. (I.e. it means copy current manual-ocaml to manual-ocaml-4.00).

Steps to reproduce

Here is an example that happened to me just today :
http://stackoverflow.com/questions/11667357/can-you-compile-an-ocaml-project-natively-as-a-windows-library

@vicuna
Copy link
Author

vicuna commented Jul 26, 2012

Comment author: @damiendoligez

Done. We should probably also try to use those stable links in the web site, so I'm leaving this PR open.

@vicuna
Copy link
Author

vicuna commented Jul 31, 2012

Comment author: @damiendoligez

The web site now uses the stable link throughout. Note that the naming convention has changed:
manual-ocaml-312 (without the period) to manual-ocaml-4.00 (with the period). The old links
will remain valid.

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

No branches or pull requests

2 participants