Stream: Coq Platform devs & users

Topic: Doc update


view this post on Zulip Michael Soegtrop (Oct 18 2021 at 11:53):

In case someone want's to have a look: I reworked the doc a bit - the largest change are auto generated readme files with detailed information on each package (using the details HTML tag). You can find the branch here: https://github.com/MSoegtropIMC/platform/tree/doc-update.

The OS specific files are todo ...

view this post on Zulip Karl Palmskog (Oct 18 2021 at 11:55):

@Michael Soegtrop if you want us to comment on specific parts of the changes, maybe you can open a draft pull request? This allows easier access to GitHub's line-by-line commenting features.

view this post on Zulip Michael Soegtrop (Oct 18 2021 at 11:57):

Oh, there is already a pr (https://github.com/coq/platform/pull/153). I just linked the branch because it is much easier to look at this (follow links ...) in the branch.

view this post on Zulip Michael Soegtrop (Oct 18 2021 at 16:25):

@Karl Palmskog : do you think we should create such a README file also for the complete Coq opam repo and publish this somewhere?

view this post on Zulip Michael Soegtrop (Oct 18 2021 at 16:37):

This should require only a few minor changes to the Coq Platform create readme script.

view this post on Zulip Michael Soegtrop (Oct 19 2021 at 07:57):

I just saw that we have (https://coq.inria.fr/opam/www/) - quite nice although it might make sense to add the licenses there. On my side I could add the category keys.

view this post on Zulip Karl Palmskog (Oct 19 2021 at 09:04):

@Michael Soegtrop I don't understand about the README file for the Coq opam repo. What would we publish exactly? (I mean this comment)

view this post on Zulip Karl Palmskog (Oct 19 2021 at 10:56):

Michael Soegtrop said:

I just saw that we have (https://coq.inria.fr/opam/www/) - quite nice although it might make sense to add the licenses there. On my side I could add the category keys.

We have an issue for the info we want to add to the underlying JSON file: https://github.com/coq/opam-coq-archive/issues/1158


Last updated: Jan 29 2023 at 19:02 UTC