Repository navigation
Conversation
b968b6e to
b75d475
Compare
|
Preview for this PR is ready! 🎉 (also as a proofreading version). built with commit 97aa44d. |
97aa44d to
2150fa4
Compare
|
|
||
| {docstring Widget.WidgetInstance} | ||
|
|
||
| Lean can display widgets in two ways: within messages in the {tech}[message log], or as {tech (key := "InfoView panel widget")}[InfoView panels] associated with a source span. |
There was a problem hiding this comment.
I think this text belongs higher in the chapter, up near the initial discussion of widgets. That way the reference to panel widgets that I stumbled on earlier will have a higher chance of being understood.
There was a problem hiding this comment.
I didn't really intend for this to be read linearly. I am thinking of this chapter (and refman as a whole) as more of a reference that one can jump around to locate relevant technical information efficiently.
| open Verso.Genre Manual InlineLean | ||
| open Lean Widget | ||
|
|
||
| #doc (Manual) "Widgets" => |
There was a problem hiding this comment.
Having read the whole thing and looked at its place in the ToC, I think this section should have a bit more in the intro to situate it and help readers figure out if it's for them. Can it lead with some use cases and associated screenshots before digging in to editors and InfoViews and React?
There was a problem hiding this comment.
Hm, I think I would prefer to leave this as-is in this respect. I feel like the manual should mostly provide efficient access to relevant technical information. We can leave motivation and friendlier text to the tutorials.
2150fa4 to
2187bc5
Compare
This PR adds a section on widgets to the reference manual.