search

gfx-rs / wgpu

A cross-platform, safe, pure-Rust graphics API.
https://wgpu.rs
Apache License 2.0
12.31k stars 906 forks source link

Internal documentation #5444

Open lylythechosenone opened 6 months ago

lylythechosenone commented 6 months ago

Rust's libstd currently has doc.rust-lang.org for users, and stdrs.dev for developers. This is useful because it allows a glimpse into internals without opening the project and manually navigating through code. We could host it on the website, or really anywhere else. All it requires is some CI to run cargo doc --document-private-items and upload the results.

Action items:

  1. Decide where these docs should be published
  2. Create some CI to build and upload docs on push
cwfitzgerald commented 6 months ago

We already are most of the way there, we host trunk's docs https://wgpu.rs/doc/wgpu/, we could potentially turn on private item docs there. We could also have both.

lylythechosenone commented 6 months ago

That's a perfect solution, actually.

lylythechosenone commented 6 months ago

@cwfitzgerald should I go ahead and implement this in the CI, or do you want to discuss it more first?