<div dir="ltr">I totally +1 that. Unexperienced users' first interaction with a confusing UI would probably be to go to the help button. If that fails them or tells them something confusing or unactionable (because it refers to a previous version of the app), they will be too deterred to even report bugs.</div><div class="gmail_extra"><br><div class="gmail_quote">On 16 February 2015 at 23:33, Simon Steinbeiß <span dir="ltr"><<a href="mailto:simon@xfce.org" target="_blank">simon@xfce.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hey everyone,<br>
<br>
since the release date is creeping up on us, I quickly want to highlight a feature libxfce4ui has gained during this cycle and that is support for versioned docs. What this means is that if a user clicks "Help" in your app/component they will be redirected to the corresponding version of the docs online. This will help us account for differences without abandoning previous documentation.<br>
<br>
Two parts of core already use this for a while – xfdesktop4.11 and xfce4-power-manager1.4 – so you can test those to see how things should work. I pushed support for this to xfce4-settings as well [1], as there are some quite visible and drastic changes e.g. in xfce4-display-settings that warrant a doc refresh.<br>
<br>
>From my point of view, all of our components should support this. Of course, this initially means that if you wanna do a major version bump, the Help button will point to a non-existing page in the docs-wiki. However, the simple fix is to copy-paste the content of older docs over and then to incrementally improve/adjust those to fit the new version. (Obviously using less screenshots makes this process less laborious.)<br>
<br>
Anyway, it's fairly easy to add this in, so please go ahead and ahead of 4.12. While this means that until the release, the Help links will point to the void of a non-existing 4.11 page, it might be a good incentive for people to help us with documentation ;)<br>
<br>
Cheers<br>
Simon<br>
<br>
<br>
PS: Another procedural remark: the main page of the docs should always point to the latest stable version of the component, so until 4.12 is released, <a href="http://docs.xfce.org/xfce/xfdesktop/start" target="_blank">http://docs.xfce.org/xfce/xfdesktop/start</a> should point to the 4.10 docs. After the 4.12 release, that page should be moved to <a href="http://docs.xfce.org/xfce/xfdesktop/4.10/start" target="_blank">http://docs.xfce.org/xfce/xfdesktop/4.10/start</a> to make space for the refreshed docs.<br>
<br>
<br>
[1] <a href="http://git.xfce.org/xfce/xfce4-settings/commit/?id=ca5c4aed4525c12935a8e61dbb0f2e0509e50c6a" target="_blank">http://git.xfce.org/xfce/xfce4-settings/commit/?id=ca5c4aed4525c12935a8e61dbb0f2e0509e50c6a</a><br>
_______________________________________________<br>
Xfce4-dev mailing list<br>
<a href="mailto:Xfce4-dev@xfce.org">Xfce4-dev@xfce.org</a><br>
<a href="https://mail.xfce.org/mailman/listinfo/xfce4-dev" target="_blank">https://mail.xfce.org/mailman/listinfo/xfce4-dev</a></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature">Steve Dodier-Lazaro<br>PhD Student<br>University College London<br>Free Software Developer<br>OpenPGP : 1B6B1670</div>
</div>