Re: [MirageOS-devel] docs.mirage.io building again

[Anil Madhavapeddy <anil@xxxxxxxxxx>]

Dear all,

Another update on http://docs.mirage.io:

There has been quite a significant bit of work on odoc over the past few months 
by Daniel Buenzli and Thomas Refis, and so docs.mirage.io should reflect many 
of these:

- it now uses odoc by default, and not ocamldoc! You can find the old ocamldoc 
generation in the hidden url of http://docs.mirage.io/_ocamldoc if you really 
need it, but odoc is pretty good now for day-to-day use.
- it has been rebuilt with many rendering fixes for odoc, but please continue 
to report any issues you find to https://github.com/ocaml-doc/odoc/issues
- the latest mirage-dev packages are also included, but please do feel free to 
suggest more packages you would like in the central trove.  The list is at 
https://github.com/mirage/mirage in the Dockerfile.doc file, but I will 
probably move it out into a separate place before the release. I'll update the 
list when I do, but for now just propose packages directly in there.

regards,
Anil

> On 1 Nov 2016, at 12:22, Anil Madhavapeddy <anil@xxxxxxxxxx> wrote:
> 
> Another round of updates and the new http://docs.mirage.io is now deployed 
> with new packages for:
> - charrua-unix
> - cpuid
> - hkdf
> - jenga
> - logs-syslog
> - mirage-block-ccm
> - mirage-logs
> - mirage-os-shim
> - mirage-stdlib-random
> - ocb-stubblr
> - otr
> - pbkdf
> - scrypt-kdf
> - syslog-message
> 
> The tracking issue for bugs/features for docs is:
> https://github.com/mirage/mirage/issues/609
> 
> New bugs in there since the last round are support for ppx in interface files 
> (which seems to break things right now) and the 404s for CHANGES/README 
> (thanks Hannes for noticing).  If your request isnt on that list (aside from 
> search, which is a bigger issue), please comment on there.
> 
> thanks
> Anil
> 
>> On 28 Oct 2016, at 13:54, Anil Madhavapeddy <anil@xxxxxxxxxx> wrote:
>> 
>> Thanks for the pointer Nicolas, I didn't realise that was still under active 
>> development! Hooking it into odig should be a fun exercise.
>> 
>> An update on docs.mirage.io:
>> 
>> - it is now building again after the latest batch of mirage/mirage-dev 
>> changes.  Thanks to David Kaloper for lots of hard work on fixing up 
>> mirage-entropy and the associated packages.
>> - we now have more packages in there, such as cpuid 
>> http://docs.mirage.io/odoc/cpuid/Cpuid/index.html
>> - the odoc backend was temporarily broken but is also now working again; 
>> http://docs.mirage.io/odoc/ -- please report any cross-referencing issues on 
>> the https://github.com/ocaml-doc repos.
>> 
>> As usual, please iterate through the list and try to refresh any older 
>> packages to match the odig convention so that we have more metadata in place 
>> for LICENSES, CHANGES and versions.  This is an ongoing process so I'll keep 
>> reminding us all about it :-)
>> 
>> regards,
>> Anil
>> 
>>> On 21 Oct 2016, at 16:18, Nicolas Ojeda Bar <n.oje.bar@xxxxxxxxx> wrote:
>>> 
>>> Re search:
>>> 
>>> http://ocamloscope.herokuapp.com/
>>> 
>>> and
>>> 
>>> https://twitter.com/camlspotter/status/789416138333573120
>>> 
>>> Cheers!
>>> 
>>> - Nicolas
>>> 
>>> 
>>> On Fri, Oct 21, 2016 at 5:04 PM, Anil Madhavapeddy <anil@xxxxxxxxxx> wrote:
>>>> On 19 Oct 2016, at 16:57, Anil Madhavapeddy <anil@xxxxxxxxxx> wrote:
>>>>> 
>>>>> On 19 Oct 2016, at 10:56, Martin Lucina <martin@xxxxxxxxxx> wrote:
>>>>>> 
>>>>>> On Friday, 14.10.2016 at 11:29, Anil Madhavapeddy wrote:
>>>>>>> Good news everyone! The experimental documentation repository at 
>>>>>>> http://docs.mirage.io now builds again, and has been refreshed to the 
>>>>>>> latest set of libraries assembled from the MirageOS3 dev remote at 
>>>>>>> https://github.com/mirage/mirage-dev
>>>>>> 
>>>>>> Some ideas for UX improvements to the docs pages:
>>>>>> 
>>>>>> 1) Hyperlinks on types. Eg. in functoria/Functoria_app.Cmd.html
>>>>>> "Rresult.result" should link to rresult/Rresult.html.
>>>>>> 
>>>>>> 2) A "Path" nagivation header with the full hierarchy. E.g.
>>>>>> rresult/Result.html currently has "Up", which takes me to the package's
>>>>>> index.page but I can't go "Up" from there.
>>>>>> 
>>>>>> 3) A "Search" box of some sort. Ideally just client-side, search over
>>>>>> packages/modules/types/descriptions?
>>>>> 
>>>>> Thanks Martin! I've updated the tracking issue at 
>>>>> https://github.com/mirage/mirage/issues/609 and filed a couple of 
>>>>> upstream issues on odig about this.
>>>> 
>>>> http://docs.mirage.io is now rebuilding again after the latest set of 
>>>> library merges and API changes.  There is some temporary breakage in the 
>>>> odoc CSS that Thomas Refis and Daniel Bunzli are working on, so just use 
>>>> the ocamldoc version for now.
>>>> 
>>>>> I'm not quite sure who will handle search across cmt files yet.  Is this 
>>>>> on the roadmap or want-list for Merlin? (this question is mainly directed 
>>>>> at Fred or Gemma, who have been looking at the Merlin feature roadmap 
>>>>> recently).
>>>> 
>>>> And looking at search more, I'm reasonably sure that this won't happen in 
>>>> the short term for docs.mirage.io in odoc -- we should be looking at some 
>>>> Merlin or Hoogle-like solution.
>>>> 
>>>> Anil
>>>> 
>>>> 
>>>> _______________________________________________
>>>> MirageOS-devel mailing list
>>>> MirageOS-devel@xxxxxxxxxxxxxxxxxxxx
>>>> https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel
>>> 
>>> _______________________________________________
>>> MirageOS-devel mailing list
>>> MirageOS-devel@xxxxxxxxxxxxxxxxxxxx
>>> https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel
>> 
>> _______________________________________________
>> MirageOS-devel mailing list
>> MirageOS-devel@xxxxxxxxxxxxxxxxxxxx
>> https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel
> 
> _______________________________________________
> MirageOS-devel mailing list
> MirageOS-devel@xxxxxxxxxxxxxxxxxxxx
> https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel


_______________________________________________
MirageOS-devel mailing list
MirageOS-devel@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel