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

More intro material from a Rustacean point of view #2675

Open
Manishearth opened this issue Sep 28, 2022 · 4 comments
Open

More intro material from a Rustacean point of view #2675

Manishearth opened this issue Sep 28, 2022 · 4 comments
Labels
C-meta Component: Relating to ICU4X as a whole help wanted Issue needs an assignee T-docs-tests Type: Code change outside core library

Comments

@Manishearth
Copy link
Member

I think ICU4X's readme and tutorials are largely written from the point of view of "I am an internationalization user and I want to use ICU4X", which is quite reasonable since that is the majority of our clients.

I do think that we should also try and pay attention to the potential user base of Rustaceans who may not necessarily know much about internationalization.

I do try to make some fixes along these lines in #2674 (inspired by feedback from @Gankra) but we probably need deeper changes.

A nice thing about the Rust community is that in general folks tend to be rather curious and interested in other Rust projects, even if they don't plan to use it any time soon. This leads to a lot of foot traffic on libraries due to curiousity rather than need, and I think so far ICU4X's tutorials and readme (and the draft 1.0 blog post) target people coming here from need. It would be good for ICU4X to also target people arriving here out of curiosity, which will be great for growing the group of people who will wish to advertise the library when they hear someone has needs that fit, and also leading to potential contributors. I've contributed to plenty of Rust libraries that I have basically no intention of using, because the libraries were cool.

I think I see two questions we could be answering better:

  • Why should I, a Rustacean, care about this library? Why would I want to use this?
  • I'm a Rustacean wanting to internationalize my application, what should I know?

The latter one is technically broader in scope than just ICU4X (people wanting to internationalize will likely want to use something like fluent as well, and also some translation management interface, and a bunch of other such things), but we can try to answer that question in the context of ICU4X at least, to make it easier for whoever eventually writes a general guide of this form.

cc @sffc @zbraniecki @echeran

@zbraniecki
Copy link
Member

I agree. I think we need to continue building on recent improvements - I think our API docs are very good (not great yet!), and we have tutorials that provide the onboarding when necessary.

What I'd like us to improve is to go one step further in two directions:

  • Introduce i18n. I understand we won't have a lot of time for it, but bridging the gap from "I stumbled upon ICU4X and it tells me it solves internationalization. What is internationalization? What makes it complex? What are major concepts?" would be great.
  • Have a smooth rabbit hole dives from "Here is your first use of ICU4X" to "i18n date is hard, integration with app is hard, we developed a very very sophisticated system to handle it, and you will need to think how you want to use it". Shane wrote this in APi docs, now linking it from tutorials is going to help.

@Manishearth
Copy link
Member Author

Yeah that's a good sketch I think!

@echeran
Copy link
Contributor

echeran commented Oct 5, 2022

  • Introduce i18n. I understand we won't have a lot of time for it, but bridging the gap from "I stumbled upon ICU4X and it tells me it solves internationalization. What is internationalization? What makes it complex? What are major concepts?" would be great.

The videos from Unicode's Overview of Internationalization and Unicode Projects event last week are now live on the interwebs. They should do a pretty good job of surveying high level concepts about i18n. The videos even include the presentation about ICU4X, which announces the 1.0 release, by our very own @sffc !

@Manishearth
Copy link
Member Author

Yeah, however I don't think video content is ideal for our main entry point and I think having stuff focused towards potential icu4x users would be good

@sffc sffc added T-docs-tests Type: Code change outside core library help wanted Issue needs an assignee labels Oct 17, 2022
@sffc sffc added this to the ICU4X 1.x Untriaged milestone Oct 17, 2022
@sffc sffc added the C-meta Component: Relating to ICU4X as a whole label Oct 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-meta Component: Relating to ICU4X as a whole help wanted Issue needs an assignee T-docs-tests Type: Code change outside core library
Projects
None yet
Development

No branches or pull requests

4 participants