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

Adding to the book #1729

Open
13 tasks
arthmis opened this issue Apr 19, 2021 · 4 comments
Open
13 tasks

Adding to the book #1729

arthmis opened this issue Apr 19, 2021 · 4 comments
Labels
docs concerns documentation help wanted has no one working on it yet

Comments

@arthmis
Copy link
Collaborator

arthmis commented Apr 19, 2021

Hi, there are some parts of the book that I think don't need a druid expert in order to write. Would it be fine to leave this issue here and track what parts need help or entire additions? I can probably add a task list.

So this is a rough task list split by chapters:

Getting Started With Druid

  • Finish Application state section
  • Write Handle user input section
  • Write Putting it all together section

Localization

  • I don't know what needs to be done here.

Command

  • I also don't know what need to be done here.

Widgets in Depth

  • Layout
  • how constraints work
  • child widgets and set_layout_rect
  • paint bounds
  • container widgets
  • widgetpod & architecture
  • commands and widgetid
  • focus, active, hot, (disabled when it gets there)
  • request paint & request layout
  • changing widgets at runtime

More information

@arthmis arthmis added docs concerns documentation help wanted has no one working on it yet labels Apr 19, 2021
@futurepaul
Copy link
Collaborator

I'd be happy to contribute my todo tutorial to the book if we think it's in scope / idiomatic enough.

@arthmis
Copy link
Collaborator Author

arthmis commented Apr 21, 2021

I feel like @futurepaul if your tutorial goes over the concepts presented in the Getting Started With Druid chapter then maybe it could replace it with some changes? @cmyr

Also, @cmyr are there any additions or changes you want to make to the task list?

@SecondFlight
Copy link
Collaborator

I have been keeping my own docs wishlist while learning Druid, and I've pasted it below. I've kept it to myself so far since I haven't had bandwidth to see any of it through. @arthmis I'm not sure how much of this is appropriate for your list, but please add anything that you think would be good!

  • Examples for:
    • Custom widgets
    • Custom container widgets
    • Custom lenses
    • Custom scopes
  • How to create a scope from a lens
  • How to create a lens from a function
  • Loading and using custom fonts
  • How to use Arc in a state tree
  • Best practices for managing large state trees

@arthmis
Copy link
Collaborator Author

arthmis commented Apr 21, 2021

I think the examples you mentioned would definitely be useful to add. There could probably be some chapter on common patterns, like how to use widgetpod to create container widgets, how to create your own custom layout widget, how to use subwindows to create dropdowns and so on.

I also think there should be a project showcase chapter in the book now if people are willing to have their more complete projects there. There could probably be pictures for each project if the book supports that. I also think runebender should be there too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs concerns documentation help wanted has no one working on it yet
Projects
None yet
Development

No branches or pull requests

3 participants