docs and examplesgood first issuehelp wanted
Métriques du dépôt
- Stars
- (29 051 stars)
- Métriques de merge PR
- (Merge moyen 11j 20h) (47 PRs mergées en 30 j)
Description
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:
- intro tutorial
- FAQ (see https://github.com/emilk/egui/issues and https://github.com/emilk/egui/discussions/categories/q-a for what the common questions are)
- examples for common widgets, layouts etc (see below)
- 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
- Meta: make the CI run all the doc tests
- Fix the
eframedoc build issues: https://github.com/emilk/egui/issues/146 - Add simple demo of loading and displaying an image
-
epi::httpin not showing up in the documentations