Update documentation for Juvix 0.6.8 #124
Conversation
|
The preview of this PR failed to build. Please check the logs. |
jonaprieto
force-pushed
the
update-docs
branch
from
375e44c
to
17d6440
Compare
| @@ -131,11 +131,6 @@ plugins: | |||
|
|
|||
| nav: | |||
| - ./README.juvix.md | |||
| - About: | |||
There was a problem hiding this comment.
I read the Changelog from time to time. Why do you want to remove it?
I'd go even further and promote it as its own tab.
The rest of the info in About may be useful for some people; I'd suggest moving to the end, perhaps after Discord.
There was a problem hiding this comment.
The "About" section mostly duplicated information available elsewhere, e.g., the front page, sometimes even repeating the same sentences. We want to keep information relevant for Juvix newcomers, save them from information overload and allow them to find relevant info about using Juvix quickly. If someone wants to see the Changelog, they can go to github. As the Changelong is not relevant to actually using Juvix, I don't see a reason to keep it in the language documentation.
But the "Talks" subpage should be preserved
|
|
||
| ## Related internal reports | ||
|
|
||
| An ongoing effort to specify the Juvix language and internal representations | ||
| along its semantics is being carried out in the form of internal reports. These | ||
| reports are written for our own internal use and are not intended to be read by | ||
| the public, at least for now. However, we are making them available here | ||
| for the sake of transparency. | ||
|
|
||
| <div style="text-align:center" markdown> | ||
|
|
||
| | Title | Doi/url | Date | | ||
| | :------------------------- | :---------------------------------------------------------- | :----------- | | ||
| | Juvix to VampIR Pipeline | [10.5281/zenodo.8268823](https://zenodo.org/record/8268823) | Aug 14, 2023 | | ||
| | The Core language of Juvix | [10.5281/zenodo.8297159](https://zenodo.org/record/8297159) | Aug 29, 2023 | | ||
| | Geb Pipeline | [10.5281/zenodo.8262747](https://zenodo.org/record/8262747) | Aug 21, 2023 | | ||
| | Rethinking VampIR | [10.5281/zenodo.8262815](https://zenodo.org/record/8262815) | Aug 29, 2023 | | ||
|
|
||
| </div> |
There was a problem hiding this comment.
I'd keep this information (perhaps rewrite/simplify the paragraph, change the title) and update the table. Also, add @lukaszcz's latest report on Cairo. I'm sure some people find these reports useful.
There was a problem hiding this comment.
I added back the reports, though they don't really fit into "Language reference" -- they are about compiler implementation, not the language itself.
There was a problem hiding this comment.
Maybe I move this to separate subpage under "Reference".
|
Success! The preview of this PR will be available at https://docs.juvix.org/pull-124/ in a few minutes. Please note that this link will be deleted when the PR is closed or merged. |
paulcadman
force-pushed
the
update-docs
branch
from
2b4b8df
to
4f4121a
Compare
lukaszcz
changed the title
Major rewrite of the documentation