emilk/egui

Improve documentation and examples

Open

#186 opened on 2021年2月20日

GitHub で見る
 (3 comments) (18 reactions) (0 assignees)Rust (2,037 forks)batch import
docs and examplesgood first issuehelp wanted

Repository metrics

Stars
 (29,051 stars)
PR merge metrics
 (平均マージ 11d 20h) (30d で 47 merged PRs)

説明

Tracking issue for improving the egui docs. Other suggestions for improvements welcome!

All doc-examples need to be part of the doctests (i.e. they should never be marked ignore, though no_run can maybe sometimes be motivated).

egui

The crate-level docs for egui (at https://docs.rs/egui generated from egui/src/lib.rs) should be improved with a tutorial. In addition, all major parts of egui should have a quick example in the crate-level docs

  • Crate-level:
  • Crate-level AND item-level examples for:
    • Label
    • Hyperlink
    • TextEdit
    • Button
    • CheckBox
    • RadioButton
    • SelectableLabel
    • Image
    • ComboBox
    • Slider
    • DragValue
    • Separator
    • CollapsingHeader
    • horizontal and vertcial layouts
    • centered vertical layouts
    • Grid
    • tooltips (on_hover_text)
  • Add a few gifs to the docs (not too many though, as they are difficult to maintain)
  • Links from the web demo to the docs
    • Link from the widget gallery to the docs
    • Link from the slider demo to the docs for the slider
  • Links from the docs to the web demo
    • Link from the crate-level docs to the web demo
    • Link from the Slider-docs to the slider demo window
  • Links from the web demo to its own source code

other

コントリビューターガイド