Replies: 1 comment 1 reply
-
Yes, you're absolutely right. This should be fixed. I think we can use a permanent links to a specific revision. It will be ideal solution. The only question is how we can update our old documentation to point correct location. |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
It would be great if the source links of tasks would link to the proper version. If I open the docs for
v7.x
and want to see the source of a provision task for example (https://deployer.org/docs/7.x/recipe/provision#tasks), they link to themaster
branch https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L46As the
v7.x
is not the most current version, it is not developed in themaster
branch anymore, but in the7.x
branch. This could show code that is not relevant to the version the user was browsing in the docs, and potential changes might have shifted the correct line the user is looking for.The relevant link in this case would be: https://github.com/deployphp/deployer/blob/7.x/recipe/provision.php#L46
Of course, it is the user's responsibility to make sure they are looking at the correct thing and older versions are not the main focus. As
v8.x
is not yet considered stable, most people will check the docs and source code forv7.x
and the docs are automatically generated withdocgen
, it might be a good trade off between effort and benefit, to consider improving this :)Beta Was this translation helpful? Give feedback.
All reactions