Re: Can the documentation for Unison be migrated from the UPenn site?

Tõivo Leedjärv <[email protected]> writes:

> On Fri, 21 Jul 2023 at 15:33, Greg Troxel <[email protected]> wrote:
>>
>> Jonathan Whiteley <[email protected]> writes:
>>
>> > 1. I'm using the Unison GUI v2.53.3, which appears to be the latest
>> > version, on my Mac (macOS Ventura).  The Help menu contains a "Unison
>> > Online Help" item, which still points to
>> > https://www.cis.upenn.edu/~bcpierce/unison/docs.html, which only gives a
>> > 404 error. :(  I don't know if this is something that is controlled by
>> > Unison developers directly, or if someone else is creating the mac
>> > binaries, but it can lead to confusion.
>>
>> I think that's fixed, but if it's still wrong in the manual sources
>> please open an issue.
>
> I don't think it's fixed:
> https://urldefense.com/v3/__https://github.com/bcpierce00/unison/blob/master/src/uimac/MyController.m*L1099__;Iw!!IBzWLUs!RqTqoUWWBIVmEd5YWMUVYkJmJSFC87SXrRTP5l9SZz1XOqEhI68ncn45yOzU_NCvk_TNJUVwg1rpoyIDuw$ 

Ah, I didn't realize this was a mac-specific issues.

> The question is, where should it point to since online documentation
> is no longer available?

I don't want to accept keeping a nice online manual available as a
project obligation.  The html and pdf are in the build artifacts, and
should be included by packages.  As a fundamental philosophical point, I
think software should be fully usable without an internet connection.
So, I somewhat view an online documentabbtion pointer as a bit of a bug
in the first place :-)

This is sort of academic, but when we migrate, there will be the
question of "is this new setup good enough", and I don't want to make
that any harder than it needs to be.

But, given where we are already a reasonable place to point to is

  https://urldefense.com/v3/__https://github.com/bcpierce00/unison/wiki__;!!IBzWLUs!RqTqoUWWBIVmEd5YWMUVYkJmJSFC87SXrRTP5l9SZz1XOqEhI68ncn45yOzU_NCvk_TNJUVwg1qXvptdAA$ 

I have just adjusted that to replace the (confusing to me) "Downloading"
term to be clearer that it is about sources and binaries.

I also added links to raw download versions of plain text, pdf, and html
versions of the manual.  The html version gets sent with a text/plain so
at least firefox doesn't render it.

-- 
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected].