Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add tutorial to documentation #376

Closed
PoignardAzur opened this issue Dec 19, 2022 · 0 comments · Fixed by #632
Closed

Add tutorial to documentation #376

PoignardAzur opened this issue Dec 19, 2022 · 0 comments · Fixed by #632
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed masonry Issues relating to the Masonry widget layer

Comments

@PoignardAzur
Copy link
Contributor

Masonry introduces a lot of complex concepts compared to other GUI frameworks. Many of these concepts are intended to reduce future complexity, but crate users don't get those benefits if they can't use the API in the first place.

Masonry should have a tutorial integrated directly into the documentation with rustdoc.

The tutorial should have the following chapters:

  • Getting started. The steps to creating a "TODO" app.
  • Creating a Widget. Present the Widget trait, the different methods, the create_widget macro, how to do tests.
  • Creating a Container Widget. Present WidgetPod, container invariants, etc.
  • Widget statuses. Hot, active, focused, stashed.

Other parts of the documentation should refer to these tutorials.
@PoignardAzur PoignardAzur added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Dec 23, 2022
@DJMcNab DJMcNab added the masonry Issues relating to the Masonry widget layer label Apr 19, 2024
@DJMcNab DJMcNab transferred this issue from linebender/masonry Jun 5, 2024
@PoignardAzur PoignardAzur mentioned this issue Oct 9, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue Oct 22, 2024
@PoignardAzur @DJMcNab
Create skeleton of documentation (#632)
e03dfdd 
This is a very messy, very basic skeleton of what Masonry documentation
will eventually look like.

Main points are:

- Dedicated documentation modules.
- Re-using most of the language from the RFCs.

Next steps are:

- Flesh out the Widget documentation.
- Rewrite all those docs in a less placeholder-y way.
- Add chapter about the widget arena.
- Spread out that pass documentation to the respective pass files.
- Rewrite ARCHITECTURE.md.
- Add screenshots.

Fixes #376 and #389.

---------

Co-authored-by: Daniel McNab <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed masonry Issues relating to the Masonry widget layer
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Create skeleton of documentation linebender/xilem
2 participants
@PoignardAzur @DJMcNab