rust-lang / rust-lang/rust-playground
Support running rustdoc and displaying the rendered output
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.4k
- Forks
- 267
- Avg merge
- 3h 2m
- Merged PRs (30d)
- 6
Description
I (and many others) regularly use the playground as a quick way to provide small examples showing rustc/clippy error cases when filing bug reports. One thing I have run into a few times is wanting to do something similar when filing rustdoc bug reports (or providing examples on Discord/Discourse).
I haven't looked into the feasibility of this much, but one thought was that it should be possible to have a tiny single-page webapp that loads an archive built with https://github.com/killercup/static-filez and allows browsing with the links inside it. The playground would then just need to run rustdoc + static-filez on the snippet and load the resulting archive with the webapp in a new page.
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
Start by assessing how the playground could invoke rustdoc and static-filez for a snippet, then review the proposed single-page webapp approach for loading and browsing the resulting archive. Done would mean a defined implementation path for running rustdoc, generating the archive, and displaying its linked rendered output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- web-dev
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100