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.

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

Rewrite Masonry documentation #389

Closed
PoignardAzur opened this issue Jun 12, 2024 · 1 comment
Closed

Rewrite Masonry documentation #389

PoignardAzur opened this issue Jun 12, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation masonry Issues relating to the Masonry widget layer

Comments

@PoignardAzur
Copy link
Contributor

Masonry's documentation has only received piecemeal updates since the port to Winit.

Even when the documentation is still accurate, it lacks overall cohesion. There isn't an ordered document explaining the major concepts users need to know to understand Masonry's flow.

Once other major changes are implemented, the documentation should be brought up to date. We should avoid procrastinating on documentation too much just because the architecture is still in progress.

@PoignardAzur PoignardAzur changed the title Rewrite documentation Rewrite Masonry documentation Jun 12, 2024
@PoignardAzur PoignardAzur added the masonry Issues relating to the Masonry widget layer label Jun 12, 2024
@waywardmonkeys waywardmonkeys added the documentation Improvements or additions to documentation label Jul 25, 2024
github-merge-queue bot pushed a commit that referenced this issue Oct 22, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
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]>
@PoignardAzur
Copy link
Contributor Author

Fixed by #809, #811, #813, #815, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation masonry Issues relating to the Masonry widget layer
Projects
None yet
Development

No branches or pull requests

2 participants