Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rustdoc compressed doc #106794

Open
pickfire opened this issue Jan 13, 2023 · 1 comment
Open

Rustdoc compressed doc #106794

pickfire opened this issue Jan 13, 2023 · 1 comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@pickfire
Copy link
Contributor

From rust-lang/docs.rs#360

The local docs are not compressed, it took up 635 MB for the current stable, half the size of the whole toolchain (1.2 GB). I think we can reopen this, but one issue is browser does not work with locally compressed files.

If the web browsers can still work with local compressed files, then I'm totally going to add it. @GuillaumeGomez

Currently local docs are stored uncompressed, one way is to start a server but that would requires user to have a step to start documentation server which makes the user experience worse. Maybe a more feasible way is to be able to compressed part of the local docs and store it in a better way?

Or we just have to wait until browsers support opening locally compressed docs.

@GuillaumeGomez GuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jan 13, 2023
@GuillaumeGomez
Copy link
Member

It's been discussed a few times already. If I remember correctly what we concluded in the last discussion about this, we don't want to require users to run a web server in order to access any documentation as it would greatly increase the complexity to access it and it would also need us to distribute a web server for that alongside the rust installation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

2 participants