emilk/egui

Improve documentation and examples

Open

#186 aberto em 20 de fev. de 2021

Ver no GitHub
 (3 comments) (18 reactions) (0 assignees)Rust (2.037 forks)batch import
docs and examplesgood first issuehelp wanted

Métricas do repositório

Stars
 (29.051 stars)
Métricas de merge de PR
 (Mesclagem média 11d 20h) (47 fundiu PRs em 30d)

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:
  • 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

Guia do colaborador

Direção de pesquisa
Foque nos itens não verificados restantes na issue de rastreamento. Comece com um widget como 'SelectableLabel' ou 'ComboBox' e adicione exemplos de documentação no arquivo de origem correspondente em egui/src/. Certifique se de que os exemplos sejam executáveis como doctests sem `ignore`. Considere também adicionar uma seção de FAQ com base em perguntas comuns das discussões. Veja a documentação no nível da crate em egui/src/lib.rs para a estrutura existente.
Pilha de tecnologia
rust
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Rust basicsegui familiarity
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75