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

xilem: Docs updating #818

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ArtyomSinyugin
Copy link
Contributor

@ArtyomSinyugin ArtyomSinyugin commented Jan 12, 2025

Draft
This PR is the proposal for xilem docs starting page. But I think I will be able to make some more commits to improve documentation.
2025-01-12 16-37-44

@ArtyomSinyugin ArtyomSinyugin force-pushed the xilem_docs branch 2 times, most recently from 0f4d725 to f6e1f33 Compare January 12, 2025 19:58
Copy link
Member

@DJMcNab DJMcNab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for providing a foundation here. The CI needs to be green to land this.

xilem/src/lib.rs Outdated Show resolved Hide resolved
xilem/src/lib.rs Show resolved Hide resolved
xilem/src/lib.rs Outdated Show resolved Hide resolved
@ArtyomSinyugin
Copy link
Contributor Author

Thanks for providing a foundation here. The CI needs to be green to land this.

Thank you for comments. Before I left some red alerts for purpose: I want to do some more work inside this PR. So, now I am going to look at Masonry docs and then will make some inserts and updates.

@ArtyomSinyugin ArtyomSinyugin force-pushed the xilem_docs branch 6 times, most recently from 17cf29c to 0173adb Compare January 14, 2025 14:45
Copy link
Member

@DJMcNab DJMcNab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this - the content for the views look good.

As mentioned, the new README content needs to be added to the "formatting" CI job.

I'm willing to make the corresponding changes to the README myself, outside of this PR, if you prefer.

xilem/README.md Show resolved Hide resolved
xilem/README.md Show resolved Hide resolved
xilem/src/lib.rs Outdated Show resolved Hide resolved
xilem/src/lib.rs Outdated Show resolved Hide resolved
xilem/src/lib.rs Outdated Show resolved Hide resolved
xilem/src/lib.rs Outdated Show resolved Hide resolved
@ArtyomSinyugin ArtyomSinyugin force-pushed the xilem_docs branch 4 times, most recently from df1e9e0 to 9796c5b Compare January 16, 2025 09:01
@DJMcNab DJMcNab marked this pull request as draft January 16, 2025 13:27
@DJMcNab
Copy link
Member

DJMcNab commented Jan 16, 2025

I've converted to draft based on your Draft in the top-level body of the PR. When you're ready for this to be reviewed/land, please remove it from draft (or one of us can finish it off if you need)

@ArtyomSinyugin
Copy link
Contributor Author

I've converted to draft based on your Draft in the top-level body of the PR. When you're ready for this to be reviewed/land, please remove it from draft (or one of us can finish it off if you need)

I think I've finished.
I would like to describe in docs some more elements, but for image, portal, progress_bar, prose, spinner, task`, etc. it take much more time for me to figure out how these elements work.

Maybe I'll do the rest later, maybe in the next PR (if nobody does it in the near future).

@ArtyomSinyugin ArtyomSinyugin marked this pull request as ready for review January 16, 2025 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants