You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
andrewrk opened this issue
Jul 22, 2023
· 0 comments
· Fixed by #19208
Labels
acceptedThis proposal is planned.autodocThe web application for interactive documentation and generation of its assets.proposalThis issue suggests modifications. If it also has the "accepted" label then it is planned.
With Disable Cache checked, Firefox downloads 13 MiB over the network for the std lib docs. Meanwhile, a tarball of the standard library source files (GZIP=-9 tar cfz std.tar.gz std/) is only 2.1 MiB. This comparison isn't even counting all the .zig files that get converted into .zig.html. The preprocessing steps that the compiler does bloats the data for dubious benefits, when autodoc could be operating on a more compact data set instead.
Furthermore, #3403 is not implemented yet, and it is a hard requirement that I am imposing. Having all the source code available instead of prerendered in separate html files is the simplest and least wasteful way to implement that feature.
I also would like to see these files deleted from zig:
Especially the lexer. There is absolutely no reason to have this in javascript instead of sharing code with the actual lexer that we have written in zig. I don't want to hear any excuses about passing strings over the wasm/js boundary. There are various strategies to do it cleanly, you just need to use your imagination.
In other software projects, "use the right tool for the job" is a fair mantra. In this particular repository, however, we need to demonstrate that Zig is truly a general-purpose programming language. Please don't invest in any more javascript logic that should be zig logic instead. I'm going to lose my shit if somebody suggests adding a package.json to the docs/ folder.
The text was updated successfully, but these errors were encountered:
andrewrk
added
proposal
This issue suggests modifications. If it also has the "accepted" label then it is planned.
autodoc
The web application for interactive documentation and generation of its assets.
labels
Jul 22, 2023
acceptedThis proposal is planned.autodocThe web application for interactive documentation and generation of its assets.proposalThis issue suggests modifications. If it also has the "accepted" label then it is planned.
With Disable Cache checked, Firefox downloads 13 MiB over the network for the std lib docs. Meanwhile, a tarball of the standard library source files (
GZIP=-9 tar cfz std.tar.gz std/
) is only 2.1 MiB. This comparison isn't even counting all the .zig files that get converted into .zig.html. The preprocessing steps that the compiler does bloats the data for dubious benefits, when autodoc could be operating on a more compact data set instead.Furthermore, #3403 is not implemented yet, and it is a hard requirement that I am imposing. Having all the source code available instead of prerendered in separate html files is the simplest and least wasteful way to implement that feature.
I also would like to see these files deleted from zig:
Especially the lexer. There is absolutely no reason to have this in javascript instead of sharing code with the actual lexer that we have written in zig. I don't want to hear any excuses about passing strings over the wasm/js boundary. There are various strategies to do it cleanly, you just need to use your imagination.
In other software projects, "use the right tool for the job" is a fair mantra. In this particular repository, however, we need to demonstrate that Zig is truly a general-purpose programming language. Please don't invest in any more javascript logic that should be zig logic instead. I'm going to lose my shit if somebody suggests adding a package.json to the docs/ folder.
The text was updated successfully, but these errors were encountered: