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

Readme out of sync with library docs #1458

Closed
MarijnS95 opened this issue Jan 20, 2025 · 3 comments · Fixed by #1459 or #1464
Closed

Readme out of sync with library docs #1458

MarijnS95 opened this issue Jan 20, 2025 · 3 comments · Fixed by #1459 or #1464

Comments

@MarijnS95
Copy link
Contributor

MarijnS95 commented Jan 20, 2025

The platform-specific notes in the README are missing a detail about gtk::init(), which is only covered in the library docs: https://docs.rs/wry/latest/wry/#platform-considerations. Perhaps it should also have a specific ### Unix/Linux subsection like the README.

The Android docs appear to have some more overlap though.

Should there be a CI process to keep these in sync to make it easier to find relevant information, regardless of where this is being read?

@MarijnS95
Copy link
Contributor Author

@amrbashir it still looks to be mostly out of sync. Why don't you use something like #[doc = include_str!("../README.md")] or cargo-readme?

@amrbashir amrbashir reopened this Jan 24, 2025
@amrbashir
Copy link
Member

I didn't know about cargo-readme, that's a cool tool

@amrbashir amrbashir linked a pull request Jan 24, 2025 that will close this issue
@MarijnS95
Copy link
Contributor Author

@amrbashir neat, thanks for replacing that so quickly! This not only helps getting and keeping The two files consistent, it also means the example code is (build-)tested against the latest source at all times.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants