Consider using iframes for rustdoc HTML files
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 232
- Avg merge
- 11h 35m
- Merged PRs (30d)
- 60
Description
One of the things https://github.com/rust-lang/docs.rs/pull/671#issuecomment-607514793, #668, https://github.com/servo/html5ever/issues/414 show is that the live server's performance is very heavily tied to the html parsing (outside of builds). It would be better to instead serve the rustdoc HTML inside of an iframe, but that would require a lot of UI testing we don't currently have.
Related issues: #595, https://github.com/rust-lang/docs.rs/issues/167
cc @Mark-Simulacrum, @pietroalbini
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the discussions linked from the issue, especially #668, #595, #167, and the referenced docs.rs and html5ever threads. Then trace how the live server serves and displays rustdoc HTML and identify the UI testing needed for an iframe-based approach. Done means the design is implemented and its UI behavior is covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- frontend, performance, web-dev
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100