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

Docs for latest iced (and historical versions)? #1

Open
nathanleiby opened this issue Apr 12, 2024 · 1 comment
Open

Docs for latest iced (and historical versions)? #1

nathanleiby opened this issue Apr 12, 2024 · 1 comment

Comments

@nathanleiby
Copy link

nathanleiby commented Apr 12, 2024

Hello!

I really appreciated your book - thank you for making it! It has helped me ramp up quickly on using Iced.

I was thinking of making a PR to clarify some differences I've noticed working in 0.12.1 of Iced, but I wasn't sure if that's something you'd like. I see that you are documenting 0.10.0 today:

(Currently, this tutorial is for version 0.10.0.)

First, are you interested in updating this tutorial to match the latest stable version of iced?

Second, are you interested in tracking multiple versions of iced, so that your current excellent docs for 0.10.x are maintained while you're able to also update to 0.12 and beyond? Similarly to how Rust crates lets you look at docs for prior versions (ex: https://docs.rs/crate/iced/0.10.0), you might do the same in your Github book. A possible approach is to use a branch for each version you want to document.

e.g.

  • 0.10.x
  • 0.12.x
  • latest (perhaps this is just main)
  • dev (if you want to start prepping for future versions before they ship)

I believe this would allow internal links to work as expected, since you are already using relative links like the below, they should stay within the branch

:arrow_right:  Next: [Drawing With Caches](./drawing_with_caches.md)
:blue_book: Back: [Table of contents](./../README.md)

--

All that said: I think a simple step forward is to push main to a 0.10.x branch to "save" it, and then start working to bring main up to date with 0.12.

If you are interested / would like any help, I'm happy to pitch in. If it's too much trouble, totally understood too. Thanks again for your excellent docs!

Cheers!

@fogarecious
Copy link
Owner

Thank you for your feedback and suggestions. It seems sensible to update the tutorial to the latest stable version, although I haven't had the opportunity to do so yet.

As per your suggestion, I've set up a branch named 0.10.x. It's linked to the main branch, ensuring that readers can access it for a complete tutorial. We can update the main branch to the latest version.

If you have any additional ideas or would like to make a pull request, please feel free to do so.

I've aimed to keep each part of the tutorial as simple as possible. If any part seems overly complex, we can consider breaking it down into smaller segments.

Have a nice day!

@andreyluiz andreyluiz mentioned this issue Apr 1, 2025
56 tasks
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

No branches or pull requests

2 participants